formZ SDK | 4.0 Call Back Reference | Object Type

# fz_otyp_cbak_io

Description

Object type io function (Required). This function is called whenever the parametric data of the object needs to be written to or read from file. Individual fields of the parametric data can be read and written using the io stream functions in the fz_iost_fset function set, defined in "fz_iost_api.h".

Plugin Prototype

fzrt_error_td fz_otyp_cbak_io(

fzrt_int | windex,
fz_objt_ptr | obj,
fzrt_ptr | parm,
fz_iost_ptr | iost,
fz_iost_dir_td_enum | dir,
fzpl_vers_td * const | version,
fzrt_unsigned_int | size )

Parameters

windex [Input]

project window index

obj [Input]

object

parm [Input]

generic pointer to the parameter block

iost [Input]

The io stream pointer.

dir [Input]

Reading or writing indicator.

version [Input, Result]

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

size [Input]

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

Returns

Error codes

Availability

5.0.0.0

Function Set

fz_otyp_cbak_fset

Defined in

fz_otyp_api.h