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

# fz_ffmt_cbak_image_bmap_write_progress_str

Description

Gets a progress string for bitmap export. This is an optional plugin implemented function. This function sets a string which is displayed in the export progress bar. If this function is not implemented (set to NULL), a default string will be used.

Plugin Prototype

fzrt_error_td fz_ffmt_cbak_image_bmap_write_progress_str(

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

Parameters

windex [Input]

project window index

ffmt_id [Input]

The file format reference id.

str [Result]

The progress string.

max_len [Input]

Ths maximum length of the progress string.

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