Script functions reference > Script functions in alphabetical order > U > UpdatePPDocStatus

UpdatePPDocStatus
Syntax
UpdatePPDocStatus(doc_handle, status[, error_code]);
A string specifying the new job status. The following values are available: stored, processing, processed, delivering, delivered, terminated, suspended, deleted, inprogress, partiallyprocessed, custom, custom1, custom2, custom3, custom4, custom5, custom6, custom7, custom8, custom9.
Description
Updates repository status of the document specified in the doc_handle parameter returned by either the GetFirstPPDoc() or the GetNextPPDoc() function.
Note:
When using the update attribute in queries, this scripting function should only be used together with update=none. It is not recommended to use it together with update=all.
Returns
num<>0
Example
$doc_id = GetFirstPPDoc();
while(num($doc_id) > 0)
{
   $ret = UpdatePPDocStatus(num($doc_id), "processed");
   $doc_id = GetNextPPDoc($doc_id);
}
OpenText StreamServe 5.6 Updated: 2013-03-01