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

# fzrt_file_floc_set_name

Description

Sets the file name in a file locator. This will set the filename for a file locator. If the file locator specified a folder previous, it will be modified to specify the file within the folder after this call. This is no attempt to validate the filename or existence of the file. If the name specifies a sub-folder within the folder, the file locator is not modified to be a folder locator for the sub-folder. If the modified file locator is used in a call to , the working folder will be set to the parent folder, not the subfolder. To receive a folder locator for a sub-folder, use .

Plugin Prototype

fzrt_error_td fzrt_file_floc_set_name(

fzrt_floc_ptr | floc,
char * | fname )

Parameters

floc [Input]

file spec created with fzrt_file_floc_init

fname [Input]

pointer to filename as a C string.

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