Function libCZI_ReaderGetAttachmentInfoFromDirectory

Function libCZI_ReaderGetAttachmentInfoFromDirectory#

Function Documentation#

LibCZIApiErrorCode libCZI_ReaderGetAttachmentInfoFromDirectory(CziReaderObjectHandle reader_object, std::int32_t index, AttachmentInfoInterop *attachment_info_interop)#

Get information about the attachment at the specified index. The information is put into the ‘attachment_info_interop’ structure. If the index is not valid, then the function returns ‘LibCZIApi_ErrorCode_IndexOutOfRange’.

Parameters:
  • reader_object – The reader object.

  • index – The index of the attachment to query information for.

  • attachment_info_interop[out] If successful, the retrieved information is put here.

Returns:

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