formZ SDK | 4.0 Call Back Reference | File Translator | Structured File Translator | Image Vector Call Back

# fz_ffmt_cbak_image_vect_write_err_label

Description

Gets the string to use as a window label for an error dialog. This function is called to get text for a window label for an error dialog. If this function is not implemented (set to NULL), a default label will be used.

Plugin Prototype

fzrt_error_td fz_ffmt_cbak_image_vect_write_err_label(

fzrt_int | windex,
fz_ffmt_ref_td | ffmt_id,
char * | str,
fzrt_int | max_len,
short * | err_id )

Parameters

windex [Input]

project window index

ffmt_id [Input]

The file format reference id.

str [Result]

The label string.

max_len [Input]

The maximum length the label string can be.

err_id [Result]

The error code for the error.

Returns

FZRT_NOERR on success. An error otherwise.

Availability

5.0.0.0

Function Set

fz_ffmt_cbak_image_fset

Defined in

fz_ffmt_api.h