formZ SDK | 5.0 API Reference | Project | File Formats
Description
Gets a translator's format reference from a translator enumerator. This performs the enumeration of the translators. To get the first translator's format reference id call . After call until nxt_ref_td is FZ_FFMT_NONE to get the file format reference ids that follow. nxt_ffmt_id will be set to FZ_FFMT_NONE to indicate the end of the enumeration.
Plugin Prototype
fzrt_error_td fz_ffmt_translator_iter_get_next(
ffmt_enum, | |
nxt_ffmt_id ) |
Parameters
ffmt_enum [Input]
The translator enumerator to initialize.
nxt_ffmt_id [Result]
The next file format reference id. This is set to FZ_FFMT_NONE when the end is reached.
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 , fz_ffmt_translator_iter_get_by_index,
Function Set
Defined in