formZ SDK | 5.0 API Reference | System | Runtime Library (FZRT) | File
Description
Gets the name of specified, indexed sub-folder in a folder. The index of a sub-folder is considered to be the position of the folder in directory order relative to the position of other sub-folders. Directory order is dependent. This set the state of the iterator to the specified index. A call to will return the folder at index+1 if it exists.
Plugin Prototype
fzrt_error_td fzrt_file_find_folder_by_index(
iterator, | |
fzrt_int | index, |
char * | file_name ) |
Parameters
iterator [Input]
iterator object returned by
index [Input]
1-based index of file. Must be less than count returned by fzrt_folder_find_init
Range: index >= 1
file_name [Result]
pointer to buffer that receives the name of the file as C string. User must allocate the buffer.
Returns
FZRT_NOERR on success, Otherwise, an error ID.
Availability
5.0.0.0
See Also
Function Set
Defined in