formZ SDK | 4.0 Call Back Reference | Command | Project Palette

# fz_palt_cbak_proj_data_io

Description

formZ calls this function to read and write any palette specific project data to a formZ project file. This function is called once when reading and writing formZ project files. The file IO is performed using the IO streams (iost) interface. This interface provides functions for reading and writing data from a file (stream) and handles all cross platform endian issues. The iost parameter is the pointer to the formZ project file and should be used in all IO Stream function calls. The IO Stream functions are fully documented in the formZ API reference. The dir parameter indicates if the file is being written with a value of FZ_IOST_WRITE or read with a value of FZ_IOST_READ. The version parameter should return the version of the data that was written when outputting a file. When reading a file, the version parameter contains the version of the data that was written to in the file (and hence being read). The size parameter is only valid when dir == FZ_IOST_READ (read). This is the size of the data that was written in the file. It is the responsibility of the plugin to maintain version changes of the plugin data.

Plugin Prototype

fzrt_error_td fz_palt_cbak_proj_data_io(

fzrt_int | windex,
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

iost [Input]

io stream point for current stream.

dir [Input]

io direction for current stream.

version [Input, Result]

if dir == FZ_IOST_READ then this is the version of the block being read. if dir == FZ_IOST_WRITE then this is the version of the block that was written (default == 0).

size [Input]

if dir == FZ_IOST_READ then this is the size of the block being read

Returns

Error codes

Availability

5.0.0.0

Function Set

fz_palt_cbak_proj_fset

Defined in

fz_palt_api.h