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

# fzrt_file_find_file_init

Description

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

Plugin Prototype

fzrt_error_td fzrt_file_find_file_init(

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

Parameters

floc [Input]

file locator

count [Result]

number of files in folder.

iterator [Result]

contains an iterator object used to get names of files

Returns

FZRT_NOERR on success, Otherwise, an error ID.

Availability

5.0.0.0

See Also

fzrt_file_find_finit, , fzrt_file_find_next_file

Function Set

fz_fzrt_file_fset

Defined in

fzrt_api.h