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

# fzrt_file_find_folder_init

Description

Initializes the iterator for finding sub-folders in a folder. This will create an iterator that can be used to get the names of all sub folders in a folder. The count does not include files in the folder.

Plugin Prototype

fzrt_error_td fzrt_file_find_folder_init(

fzrt_floc_ptr | floc,
fzrt_int * | count,
fzrt_file_iter_ptr * | iterator )

Parameters

floc [Input]

pointer to a folder which contains sub-folders to iterate through

count [Result]

number of sub-folders in folder.

iterator [Result]

receives an iterator object used to get names of sub-folders

Returns

FZRT_NOERR on success, Otherwise, an error ID.

Availability

5.0.0.0

See Also

fzrt_file_find_finit

Function Set

fz_fzrt_file_fset

Defined in

fzrt_api.h