Function libCZI_MetadataSegmentGetMetadataAsXml

Function libCZI_MetadataSegmentGetMetadataAsXml#

Function Documentation#

LibCZIApiErrorCode libCZI_MetadataSegmentGetMetadataAsXml(MetadataSegmentObjectHandle metadata_segment_object, MetadataAsXmlInterop *metadata_as_xml_interop)#

Get the XML-metadata information from the specified metadata-segment object. Note that the XML-metadata is returned as a pointer to the data (in the ‘data’ field of the ‘MetadataAsXmlInterop’ structure), which must be freed by the caller using ‘libCZI_Free’.

Parameters:
  • metadata_segment_object – The metadata segment object.

  • metadata_as_xml_interop[out] If successful, the XML-metadata information is put here.

Returns:

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