formZ SDK | 4.0 Call Back Reference | Object Attributes

# fz_attr_cbak_io

Description

Custom attribute io function (Required). This function is called whenever an attribute is written to or read from file.

Plugin Prototype

fzrt_error_td fz_attr_cbak_io(

fzrt_int | windex,
fz_iost_ptr | iost,
fz_iost_dir_td_enum | dir,
fzpl_vers_td * const | version,
fzrt_unsigned_int | size,
void * | data )

Parameters

windex [Input]

project window index

iost [Input]

The io stream pointer.

dir [Input]

Reading or writing indicator.

version [Input, Result]

When reading, this is the version with which the attribute was written. When writing, the parameter needs to be set to the attribute's current version. It is up to the plugin to keep track of the attribute's version.

size [Input]

When reading, this parameter is the size of the data when it was written. When writing, this parameter is unused.

data [Input]

Pointer to the attribute data from which to write or to which to read.

Returns

Error codes

Availability

5.0.0.0

Function Set

fz_attr_cbak_fset

Defined in

fz_objt_attr_api.h