formZ SDK | 5.0 API Reference | System | Runtime Library (FZRT) | File
Description
Gets the specified indexed file or folder. The index of a file is dependent. It is equivalent to calling _n_ times where _n_ is the index of the file or folder. The iterator must be created by fzrt_file_find_file_init or before calling this function. If the iterator is created with fzrt_file_find_file_init, this function will return the indexed file, and if the iterator is created with , this function will return the indexed sub folder. This sets the state of the iterator to the specified index. A call to will return the file or folder at index+1, if it exists.
Plugin Prototype
fzrt_error_td fzrt_file_find_floc_by_index(
iterator, | |
fzrt_int | index, |
floc ) |
Parameters
iterator [Input]
iterator object returned by corresponding fzrt_file_find_xxxx_init function
index [Input]
1-based index of floc to get. Must be less than count returned by corresponding fzrt_file_find_xxxx_init function
Range: index >= 1
floc [Result]
file locator of folder or file. Must be created prior to the call
Returns
FZRT_NOERR on success, Otherwise, an error ID.
Availability
5.0.0.0
See Also
Function Set
Defined in