Function libCZI_ReaderReadSubBlock

Function libCZI_ReaderReadSubBlock#

Function Documentation#

LibCZIApiErrorCode libCZI_ReaderReadSubBlock(CziReaderObjectHandle reader_object, std::int32_t index, SubBlockObjectHandle *sub_block_object)#

Reads the sub-block identified by the specified index. If there is no sub-block present (for the specified index) then the function returns ‘LibCZIApi_ErrorCode_OK’, but the ‘sub_block_object’ is set to ‘kInvalidObjectHandle’.

Parameters:

  • reader_object – The reader object.

  • index – Index of the sub-block.

  • sub_block_object – [out] If successful, a handle to the sub-block object is put here; otherwise ‘kInvalidObjectHandle’.

Returns:

An error-code indicating success or failure of the operation.

Contents