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

# fzrt_file_find_next_folder

Description

Gets the next sub-folder in a parent folder. The next sub-folder is the folder that follows the one, in directory order, from the previous call to , with the same iterator. If there has not been a previous call, it returns the first sub-folder in the folder. If the sub-folder returned is the last sub-folder in the parent folder, the last parameter is set to true.

Plugin Prototype

fzrt_error_td fzrt_file_find_next_folder(

fzrt_file_iter_ptr | iterator,
char * | folder_name,
fzrt_boolean * | last )

Parameters

iterator [Input]

iterator object returned by

folder_name [Result]

pointer to a buffer that receives the name of sub-folder as C string. User must allocate.

last [Result]

contains true if there are no more sub-folders, false otherwise. The sub-folder name is valid if "last" is true and the return value is FZRT_NOERR

Returns

FZRT_NOERR on success, Otherwise, an error ID.

Availability

5.0.0.0

Function Set

fz_fzrt_file_fset

Defined in

fzrt_api.h