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

# fzrt_file_floc_set_path_name

Description

Sets the pathname of a file locator. This will set the pathname of a file locator. If the locator was previously a folder locator, it is still a folder locator for the new path. If the locator was previously a file locator, it is now a file locator for the file at the new path. The implementation differs on platforms. Macintosh requires that the path exist. There is no existence check on Windows.

Plugin Prototype

fzrt_error_td fzrt_file_floc_set_path_name(

fzrt_floc_ptr | floc,
char * | path )

Parameters

floc [Input]

file locator created with fzrt_file_floc_init

path [Input]

pointer to pathname as a C string. Must be allocated by user

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