GetSegDocProperty

Syntax

GetSegDocProperty(docHandle, propertyName);

docHandle

An identifier specifying a document. You can retrieve this identifier by using either the GetFirstSegDoc(), GetCurrSegDoc(), or GetNextSegDoc() function.

propertyName

The name of the document property. The propertyName can be: • ppdocid – the Post-processor document ID. • ppjobid – the Post-processor job ID. • status – the document status. • priority – the job priority. • creationtime – returns the time when the job was stored. • processtime – the time when the job was processed. • error – the job error code. • pages – the number of pages in the job. • resrepository – the resource repository name. • strsid – the resource server name.

Description

Returns the document property specified by propertyName for the document specified by the docHandle parameter. The function can only be used if you have defined an enveloping machine. See the Document sorting and bundling documentation.

Returns

The value of propertyName.

Example

$doc_handle = GetFirstSegDoc();

$doc_id = GetSegDocProperty($doc_handle, "ppdocid");

Result:

$doc_id= 123