SetPPMetadata

Syntax

SetPPMetadata(doc_handle, metadata_name, value);

doc_handle	Identifies a document
metadata_name	A string specifying the metadata name associated with the current document.
value	A string specifying the value of the metadata associated with the current document.

Description

Sets metadata of string type for the document specified in the doc_handle parameter returned by either the GetFirstPPDoc() or the GetNextPPDoc() function.

Note:

If the metadata is not used with enveloping or sorting, the metadata must be declared with the DeclareMetadata() function at Before Job level.

Returns

0	The metadata value is set.
num<>0	Error.

Example

$doc_id = GetFirstPPDoc();

while(num($doc_id) > 0)

{

   $ret = SetPPMetaData ($doc_id, "city", "Prague");

   $doc_id = GetNextPPDoc($doc_id);

}