formZ SDK | 5.0 API Reference | System | IO Streams

# fz_iost_block_read_start

Description

Starts reading an IO stream block. This function must be called at the beginning of reading each block of data. This function reads the header of a data block. After the data os read, fz_iost_block_read_end must be called.

Plugin Prototype

fzrt_error_td fz_iost_block_read_start(

fz_iost_ptr | iost,
fzrt_UUID_td | block_id,
fzrt_unsigned_int * | block_size,
fzpl_vers_td * | version )

Parameters

iost [Input]

The IO stream.

block_id [Result]

The id of the block.

block_size [Result]

The size of the block.

version [Result]

The version of the block.

Returns

FZRT_NOERR on success. Otherwise, an error code.

Availability

5.0.0.0

Function Set

fz_iost_fset

Defined in

fz_iost_api.h