Function libCZI_CziDocumentInfoGetDimensionInfo

Contents

Function libCZI_CziDocumentInfoGetDimensionInfo#

Defined in File libCZIApi.h

Function Documentation#

LibCZIApiErrorCode libCZI_CziDocumentInfoGetDimensionInfo(CziDocumentInfoHandle czi_document_info, std::uint32_t dimension_index, void **dimension_info_json)#

Get the dimension information from the document’s XML-metadata. The information is returned as a JSON-formatted string.

Parameters:

czi_document_info – Handle to the CZI-document-info object from which the dimension information will be retrieved.
dimension_index – Index of the dimension.
dimension_info_json – [out] If successful, the information is put here as JSON format. Note that the data must be freed using ‘libCZI_Free’ by the caller.

Returns:

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