HI_GetMetadata

HI_GetMetadata

%HI_GetMetadata, %HI_SetMetadata functions


Function

%HI_GetMetadata function gets back (according to the defined key) text value of metadata that are assigned to a graphic object.
%HI_SetMetadata function sets (according to the defined key) a text value of metadata that are assigned to a graphic object.

Declaration

TEXT %HI_GetMetadata( INT in _refId, TEXT in _key ) BOOL %HI_SetMetadata( INT in _refId, TEXT in _key, TEXT in _value, BOOL in _bOverWrite )

Parameters

_refId

Reference to graphic object (reference variable).

_key

Key which specified metadata.

_value

New value of metadata.

_bOverWrite

TRUE - either metadata are inserted (if they do not exist) or the value of existing metadata is updated.
FALSE - either metadata are inserted (if metadata do not exist) or the existing value of metadata is kept.

Description

%HI_GetMetadata gets back (according to the set key) text value of metadata which is assigned to graphic object.
%HI_SetMetadata sets new metadata to the graphic object according to defined key.

Note 1

Configuration of metadata for graphic object.

%HI_SetMetadata function applies the change of metadata only on the running instance of picture.

Note 2

These functions are available also in %HIX_ version.