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

# fzrt_file_floc_get_path_name

Description

Gets the pathname of a file or folder. This will get the path name of the file. The buffer passed in path must be allocated by caller. If the file locator specifies folder, the path contains the folder name. If the file locator specifies a file, the path contains the parent folder, but not the file name.

Plugin Prototype

fzrt_error_td fzrt_file_floc_get_path_name(

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

Parameters

floc [Input]

file locator created with fzrt_file_floc_init

path [Result]

pointer to buffer that receives the pathname as a C string. Must be allocated by user

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