formZ SDK | 5.0 API Reference | System

# IO Streams

Description

formZ IO stream functions. This is a set of general stream IO functions. Although only file IO os currently implemented, this may later be extended to handle IO to blocks of memory, network sockets, or some other streaming device. Each IO function os capable of reading and writing. Which operation a function performs depends on how the iost was created.
The IO streams handle byte swapping where appropriate.
All functions follow the same form.
They return an error code ( fzrt_error_td).
The first parameter is iost.
The second parameter is a pointer to the data.
The third parameter is count of data items.
The iost functions reads/write IFF style streams.
The stream of data has a header (ID, size).
Each block of data has a header (ID, version, size).
Each block of data can be independently versioned.
Data blocks can be nested.
Blocks can be individually versioned.
UUIDs are used for block id's. These id's are used to determine what kind of data is in the block. This id will usually match the id of the plugin, tool, etc that wrote the data.

Function Sets

fz_iost_fset