formZ SDK | 4.0 Call Back Reference | Renderer

fz_rndr_cbak_wind_opts_io

Description

Window options io stream function. The window options io function needs to be implemented, if the info function returns a size other than 0 for the window options size argument. It is called, whenever the options are written to or read from a file. It is expected from the plugin to keep track of version changes. When writing, the function needs to return a version number back to formZ. When reading, the version of the window options data when written will be passed into this function by formZ. When the options are changed by a plugin, the version number should be increased. Thus, when reading older versions, they can be handled accordingly.

Plugin Prototype

fzrt_error_td fz_rndr_cbak_wind_opts_io(

fzrt_int

windex,

fz_iost_ptr

iost,

fz_iost_dir_td_enum

dir,

fzpl_vers_td * const

version,

fzrt_ptr

wind_opts )

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 window options were written. When writing, the parameter needs to be set to the window options' current version. It is up to the plugin to keep track of the version.

wind_opts [Input]

Pointer to the window options block, maintained by formZ.

Returns

Error codes

Availability

5.0.0.0

Function Set

fz_rndr_cbak_fset


Defined in

fz_rndr_api.h