formZ SDK | 5.0 API Reference | System | Runtime Library (FZRT) | File

# fzrt_file_vol_free_space

Description

Gets the amount of free space on disk volume. The file locator can be either a file or a folder. The free space is the amount of disk space for the volume on which the file resides.

Plugin Prototype

fzrt_error_td fzrt_file_vol_free_space(

fzrt_floc_ptr | floc,
fzrt_unsigned_int * | size )

Parameters

floc [Input]

parent file locator.

size [Result]

size in bytes of the free space on the disk volume

Returns

FZRT_NOERR on success, otherwise an error ID

Availability

5.0.0.0

Function Set

fz_fzrt_file_fset

Defined in

fzrt_api.h