Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 12.2   12.3   12.4   12.5   13.0   13.1   13.2   13.3   13.4   13.5    Statistic    FMM    Blog  

CUPS.GetJobState

Queries job state.

Component Version macOS Windows Linux Server iOS SDK
CUPS 2.5 ✅ Yes ❌ No ❌ No ✅ Yes, on macOS ❌ No

Deprecated

This function was deprecated. Use CUPS.GetJobsAsJSON instead.

MBS( "CUPS.GetJobState"; index )   More

Parameters

Parameter Description Example
index Index in the jobs list. Value from 0 to CUPS.GetJobsCount-1. 0

Result

The job state value.

Description

Queries job state.
Please call CUPS.GetJobsCount once before you call this function.
Value is 3 for pending, 4 for held, 5 for processing, 6 for stopped, 7 for cancelled, 8 for aborted and 9 for completed.
Please consider using CUPS.GetJobsAsJSON in future to query job list.

See also

Release notes

Example Databases

Blog Entries

This function checks for a license.

Created 18th August 2014, last changed 5th October 2020


CUPS.GetJobSize - CUPS.GetJobTitle

💬 Ask a question or report a problem