Function libCZI_CziDocumentInfoGetAvailableDimension

Function libCZI_CziDocumentInfoGetAvailableDimension#

Function Documentation#

LibCZIApiErrorCode libCZI_CziDocumentInfoGetAvailableDimension(CziDocumentInfoHandle czi_document_info, std::uint32_t available_dimensions_count, std::uint32_t *available_dimensions)#

Retrieve the set of dimensions for which “dimension info” data is available. The argument ‘available_dimensions_count’ indicates the number of elements available, and this should be ‘kMaxDimensionCount+1’ at least. If the number of available dimensions is insufficient, the function will return an error (LibCZIApi_ErrorCode_InvalidArgument). The ‘available_dimensions’ array is filled with the available dimensions, and the list is terminated with a value of ‘kInvalidDimensionIndex’.

Parameters:

  • czi_document_info – The CZI-document-info object.

  • available_dimensions_count – Number of elements available in the ‘available_dimensions’ array.

  • available_dimensions – [inout] If successful, the available dimensions are put here. The list is terminated with a value of ‘kInvalidDimensionIndex’.

Returns:

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

Contents