SetSegMetadata

Syntax

SetSegMetadata(doc_handle, metadataName, value);

doc_handle	Identifies a document
metadataName	A string specifying the metadata name associated with the document.
value	A string specifying the value of the metadata for the specified document.

Description

Sets string metadata for the document specified in the doc_handle parameter returned by either the GetFirstSegDoc(), GetCurrSegDoc(), or the GetNextSegDoc() 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	Metadata is set.
num<>0	Error

Example

$doc_id = GetFirstSegDoc();

while(num($doc_id) > 0)

{

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

   $doc_id = GetNextSegDoc($doc_id);

}