Skip to main content

libCZI_ReaderReadSubBlock

Function libCZI_ReaderReadSubBlock 

Source
pub unsafe extern "C" fn libCZI_ReaderReadSubBlock(
    reader_object: CziReaderObjectHandle,
    index: c_int,
    sub_block_object: *mut SubBlockObjectHandle,
) -> LibCZIApiErrorCode
Expand description

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’.

\param reader_object The reader object. \param index Index of the sub-block. \param [out] sub_block_object 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.