Function libCZI_AttachmentGetRawData

Function libCZI_AttachmentGetRawData#

Function Documentation#

LibCZIApiErrorCode libCZI_AttachmentGetRawData(AttachmentObjectHandle attachment_object, std::uint64_t *size, void *data)#

Copy the raw data from the specified attachment object to the specified memory buffer. The value of the ‘size’ parameter on input is the size of the buffer pointed to by ‘data’. On output, the value of ‘size’ is the actual size of the data. At most the initial value of ‘size’ bytes are copied to the buffer. If the initial value of ‘size’ is zero (0) or ‘data’ is null, then no data is copied.

Parameters:

  • attachment_object – The attachment object.

  • size – [inout] On input, the size of the memory block pointed to by ‘data’, on output the actual size of the available data.

  • data – [out] Pointer where the data is to be copied to. At most the initial content of ‘size’ bytes are copied.

Returns:

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

Contents