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

# fzrt_file_floc_get_volume_name

Description

Gets the volume name of a file locator. The volume name is the name of the disk on Macintosh. It is the pathname on Windows. If the buffer that receives the volume name is too small, the string is truncated and FZRT_NOERR is returned.

Plugin Prototype

fzrt_error_td fzrt_file_floc_get_volume_name(

fzrt_floc_ptr | floc,
char * | path,
fzrt_unsigned_int | maxlen )

Parameters

floc [Result]

file locator. User must initialize.

path [Result]

pointer to buffer to receive volume name as C string

maxlen [Input]

size of buffer in path parameter

Returns

FZRT_NOERR on success, Otherwise, an error ID.

Availability

5.0.0.0

See Also

fzrt_file_floc_init

Function Set

fz_fzrt_file_fset

Defined in

fzrt_api.h