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

# fzrt_file_floc_set_volume_name

Description

Sets the volume name of a file locator. This does not check for validity of the volume name. It will store the string passed in path, in an internal data structure. This same string will be retrieved from . Setting this string to an invalid volume can cause unpredictable results.

Plugin Prototype

fzrt_error_td fzrt_file_floc_set_volume_name(

fzrt_floc_ptr | floc,
char * | path )

Parameters

floc [Result]

file locator. User must initialize.

path [Input]

pointer to buffer to contains volume name as 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