Platforms to show: All Mac Windows Linux Cross-Platform
Back to CUPSMBS module.
CUPSMBS.CancelJob(name as string, job as Int32)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | CUPS | MBS Tools Plugin | 9.7 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
name: Name of printer or class
job: Job ID, kJobIDCurrent for the current job, or kJobIDAll for all jobs
Pass kJobIDAll to cancel all jobs or kJobIDCurrent to cancel the current job on the named destination.
Raises exception on error.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | CUPS | MBS Tools Plugin | 9.7 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
CUPSMBS.GetDestinations as CUPSDestinationMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | CUPS | MBS Tools Plugin | 9.7 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
Starting with CUPS 1.2, the returned list of destinations include the printer-info, printer-is-accepting-jobs, printer-is-shared, printer-make-and-model, printer-state, printer-state-change-time, printer-state-reasons, and printer-type attributes as options. CUPS 1.4 adds the marker-change-time, marker-colors, marker-high-levels, marker-levels, marker-low-levels, marker-message, marker-names, marker-types, and printer-commands attributes as well.
Some examples using this method:
CUPSMBS.GetJobs(name as string, OnlyMyJobs as boolean, whichjobs as Integer) as CUPSJobMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | CUPS | MBS Tools Plugin | 9.7 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
name: "" = all destinations, otherwise show jobs for named destination
OnlyMyJobs: false = all users, true = mine
whichjobs: kWhichJobsAll, kWhichJobsActive, or kWhichJobsComplete
A "whichjobs" value of kWhichJobsAll returns all jobs regardless of state, while kWhichJobsActive returns jobs that are pending, processing, or held and kWhichJobsComplete returns jobs that are stopped, canceled, aborted, or completed.
Some examples using this method:
CUPSMBS.GetPassword(prompt as string) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | CUPS | MBS Tools Plugin | 9.7 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
Returns "" if the user does not provide a password.
CUPSMBS.GetPPD(name as string) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | CUPS | MBS Tools Plugin | 9.7 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
Returns Filename for PPD file.
For classes, cupsGetPPD returns the PPD file for the first printer in the class.
The returned filename is stored in a static buffer and is overwritten with each call to cupsGetPPD or cupsGetPPD2. The caller "owns" the file that is created and must unlink the returned filename.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | CUPS | MBS Tools Plugin | 9.7 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
CUPSMBS.LastErrorString as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | CUPS | MBS Tools Plugin | 9.7 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
Returns status-message text from last request.
CUPSMBS.PrintData(name as string, Data as String, Title as string) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | CUPS | MBS Tools Plugin | 16.5 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
Name: Destination name
Data: Data to print
Title: Title of job
Returns Job ID or 0 on error
CUPSMBS.PrintFile(name as string, file as folderitem, title as string) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | CUPS | MBS Tools Plugin | 9.7 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
name: Destination name
filename: File to print
title: Title of job
Returns Job ID or 0 on error
See also:
Some examples using this method:
CUPSMBS.PrintFile(name as string, file as folderitem, title as string, options() as CUPSOptionMBS) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | CUPS | MBS Tools Plugin | 9.7 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
name: Destination name
filename: File to print
title: Title of job
options: Options
Returns Job ID or 0 on error
See also:
CUPSMBS.PrintFiles(name as string, files() as folderitem, title as string) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | CUPS | MBS Tools Plugin | 9.7 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
name: Destination name
filename: Files to print
title: Title of job
Returns Job ID or 0 on error
See also:
CUPSMBS.PrintFiles(name as string, files() as folderitem, title as string, options() as CUPSOptionMBS) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | CUPS | MBS Tools Plugin | 9.7 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
name: Destination name
files: Files to print
title: Title of job
options: Options
Returns Job ID or 0 on error
See also:
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | CUPS | MBS Tools Plugin | 9.7 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
The returned value can be a fully-qualified hostname, a numeric IPv4 or IPv6 address, or a domain socket pathname.
CUPSMBS.SetDefaultPrinter(printer as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | CUPS | MBS Tools Plugin | 12.5 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
Name must be one of CUPSDestinationMBS's name.
CUPSMBS.SetServer(server as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | CUPS | MBS Tools Plugin | 9.7 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
server: | Server name |
The "server" string can be a fully-qualified hostname, a numeric IPv4 or IPv6 address, or a domain socket pathname. Pass "" to restore the default server name.
CUPSMBS.SetUser(user as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | CUPS | MBS Tools Plugin | 9.7 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
user: User name
Pass "" to restore the default user name.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | CUPS | MBS Tools Plugin | 9.7 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop, Console & Web |
The items on this page are in the following plugins: MBS Tools Plugin.