Function libCZI_CziDocumentInfoGetDisplaySettings

Contents

Function libCZI_CziDocumentInfoGetDisplaySettings#

Defined in File libCZIApi.h

Function Documentation#

LibCZIApiErrorCode libCZI_CziDocumentInfoGetDisplaySettings(CziDocumentInfoHandle czi_document_info, DisplaySettingsHandle *display_settings_handle)#

Get the display-settings from the document’s XML-metadata. The display-settings are returned in the form of an object, for which a handle is returned.

Parameters:

czi_document_info – The CZI-document-info object.
display_settings_handle – [inout] If successful, a handle to the display-settings object is put here.

Returns:

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