formZ SDK | 4.0 Call Back Reference | File Translator | Structured File Translator | Data Model Call Back

# fz_ffmt_cbak_data_model_write_file_begin_func

Description

Begins the writing of a file. This function is called at the beginning of each file to be written. Multiple files will be written when the Separate Files option is selected.

Plugin Prototype

fzrt_error_td fz_ffmt_cbak_data_model_write_file_begin_func(

fzrt_int | windex,
fz_ffmt_ref_td | ffmt_id,
void * | data,
fzrt_floc_ptr | floc )

Parameters

windex [Input]

project window index

ffmt_id [Input]

The file format reference id.

data [Input]

A pointer to translator defined data.

floc [Input]

The file to write.

Returns

FZRT_NOERR on success. An error otherwise.

Availability

5.0.0.0

Function Set

Defined in

fz_ffmt_api.h