Function libCZI_ReaderReadAttachment

Function libCZI_ReaderReadAttachment#

Function Documentation#

LibCZIApiErrorCode libCZI_ReaderReadAttachment(CziReaderObjectHandle reader_object, std::int32_t index, AttachmentObjectHandle *attachment_object)#

Read the attachment with the specified index and create an attachment object representing it. If the specified index is invalid, then the returned attachment-object handle will have the value ‘kInvalidObjectHandle’.

Parameters:

  • reader_object – The reader object.

  • index – The index of the attachment to get.

  • attachment_object – [out] If successful and index is valid, a handle representing the attachment object is put here. If the index is invalid, then the handle will have the value ‘kInvalidObjectHandle’.

Returns:

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

Contents