Function libCZI_CziDocumentInfoGetGeneralDocumentInfo

Function libCZI_CziDocumentInfoGetGeneralDocumentInfo#

Function Documentation#

LibCZIApiErrorCode libCZI_CziDocumentInfoGetGeneralDocumentInfo(CziDocumentInfoHandle czi_document_info, void **general_document_info_json)#

Get “general document information” from the specified czi-document information object. The information is returned as a JSON-formatted string. The JSON returned is an object, with the following possible key-value pairs: “name” : “<name of the document>”, type string “title” : “<title of the document>”, type string “user_name” : “<user name>”, type string “description” : “<description>”, type string “comment” : “<comment>”, type string “keywords” : “<keyword1>,<keyword2>,…”, type string “rating” : “<rating>”, type integer “creation_date” : “<creation date>”, type string, conforming to ISO 8601

Parameters:

  • czi_document_info – The CZI-document-info object.

  • general_document_info_json – [out] If successful, the general document information is put here. Note that the data must be freed using ‘libCZI_Free’ by the caller.

Returns:

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

Contents