formZ SDK | 5.0 API Reference | Project | File Formats
Description
Gets a translator's format reference from a translator enumerator. This gets the i-th item in the enumeration. If the indx is out of range, ffmt_id will be set to FZ_FFMT_NONE.
Plugin Prototype
fzrt_error_td fz_ffmt_translator_iter_get_by_index(
ffmt_enum, | |
fzrt_int | indx, |
ffmt_id ) |
Parameters
ffmt_enum [Input]
The translator enumerator to initialize.
indx [Input]
The file format reference id returned by a previous call to . To get the first ffmt_id, use FZ_FFMT_NONE.
Range: 0 <= indx < num_translators from fz_ffmt_translator_iter_init
ffmt_id [Result]
The file format reference id. This is set to FZ_FFMT_NONE if the index is out of range.
Returns
FZRT_NOERR on success. An error otherwise.
Availability
5.0.0.0
See Also
fz_ffmt_translator_iter_ptr, fz_ffmt_translator_class_enum, fz_ffmt_translator_iter_init, , fz_ffmt_translator_iter_finit
Function Set
Defined in