formZ SDK | 4.0 Call Back Reference | File Translator

# fz_ffmt_cbak_info

Description

Gets information about a file translator. This information is used by formZ to place the file format in the appropriate places in the formZ user interface.
This function also associates a keyword with a translator. Other plugins can then use this keyword to obtain a translator's reference id. For example a model file translator can obtain a reference id for a tiff translator using the "TIFF" keyword to export textures as tiff files. formZ supplied keywords are defined in formZ_vendor.h.
The file_ext string can contain up to FZRT_STDF_MAX_NUM_EXT extensions. Each extension must be less than FZRT_STDF_MAX_EXT characters. The extensions are separated by the colon ':' character. If this string contains more than FZRT_STDF_MAX_NUM_EXT extensions, only the first FZRT_STDF_MAX_NUM_EXT extensions will be used.

Plugin Prototype

fzrt_error_td fz_ffmt_cbak_info(

char * | sortby,
fzrt_int | sortby_max_len,
char * | file_ext,
fzrt_int | file_ext_max_len,
char * | keywd,
fzrt_int | keywd_max_len,
fzrt_int * | attr_flags )

Parameters

sortby [Result]

A string used to sort file format names in user interface lists and menus.

sortby_max_len [Input]

The maximum length in bytes of the sort string.

file_ext [Result]

The file extensions recognized by the file format.

file_ext_max_len [Input]

The maximum length in bytes of the file extension.

keywd [Result]

The format keyword.

keywd_max_len [Input]

The maximum length in bytes of the format keyword.

attr_flags [Result]

Translator attribute flags.

Bit Flag Type: fz_ffmt_format_attr_flags_enum

Returns

FZRT_NOERR if the IO was successful. An error otherwise.

Availability

5.0.0.0

Function Set

fz_ffmt_cbak_info_fset

Defined in

fz_ffmt_api.h