Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

CUPS.GetJobsCount

Selects some jobs and returns the count of jobs found.

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.GetJobsCount" { ; Name; OnlyMyJobs; whichJobs } )   More

Parameters

Parameter Description Example Flags
Name Name of the printer queue to query.
If no name or empty string is specified, we get all queues.		 "Brother_DCP_8085DN" Optional
OnlyMyJobs Pass either "my" for your users jobs or "all" for all jobs. "all" Optional
whichJobs Pass "active" to get only active jobs, "all" for all jobs or "complete" for completed jobs. "complete" Optional

Result

The number of jobs found.

Description

Selects some jobs and returns the count of jobs found.
First call this function to build job list. Then call other GetJob* functions to query values.

With indexes from 0 to count-1, you can call the other functions CUPS.GetJobState, CUPS.GetJobCompletionTime, CUPS.GetJobCreationTime, CUPS.GetJobProcessingTime, CUPS.GetJobPrinter, CUPS.GetJobID, CUPS.GetJobTitle, CUPS.GetJobPriority, CUPS.GetJobFormat, CUPS.GetJobSize and CUPS.GetJobUser.

Please consider using CUPS.GetJobsAsJSON in future to query job list.

Examples

Query all jobs:

MBS( "CUPS.GetJobsCount"; ""; "all"; "all"" )

See also

Release notes

Blog Entries

This function checks for a license.

Created 18th August 2014, last changed 3th April 2021


CUPS.GetJobsAsJSON - CUPS.GetPrinterCount