GetMetaDataMessageFrom

Syntax

GetMetaDataMessageFrom(messageID, typeID, typeVersion, key, value);

messageID	A GUID identifying a paused Message in the Message storage.
typeID	A GUID identifying the document type that the Message uses.
typeVersion	N/A. For future use. Set to 0 (zero) in 5.6.2.
key	A GUID identifying the metadata to return the value for.
value	A variable that will receive the metadata value. The variable must be a global variable.

Description

Retrieves a metadata value from a paused Message in the Message storage and assigns it to a variable. The metadata must have the Message context.

For example, you can use the script function in a scenario where you want to compare the metadata value in a paused Message to the current metadata value in a source system in order to detect changes.

The script function can be used at any level and in any script.

Returns

The metadata value, assigned to the global variable. In case a metadata value could not be assigned, one of the following is returned:

	Unspecified error, for example, a database error.
	No metadata with the key exists.
	The metadata key is not in a valid format.
	The metadata value is not correctly formatted. For example, when trying to set a numeric property to a string that cannot be converted to a number, or trying to set a date metadata to a number that cannot be converted to a date.
	No Message matching the supplied Message ID and type ID was found.

Example

$value_out = "<Not Found>";

GetMetaDataMessageFrom("20261723-4DA2-714C-AE36-17C057DDAB8D", "541A722B-E349-4C6F-BEB5-4A9C255B7C37", 0, "45F562AE-474A-42CF-A6A0-61A193BA677C", $value_out);

Log(0, "MetaDataFrom (1)= " + $value_out);