GetSegJobProperty

Syntax

GetSegJobProperty(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 job property. The propertyName can be: • ppjobid – the Post-processor job ID. • status – the job status. • priority – the job priority. • creationtime – 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 job. • name – the job name. • strsid – the StreamServe job ID. • user – the user name. • description – the description of the job.

Description

Returns the job property specified in the propertyName parameter for the document specified in 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 = GetSegFirstDoc();

$job_id = GetSegJobProperty($doc_handle, "ppjobid");

Result:

$job_id = 1