Xojo Conferences
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

CPMPrinterMBS.Constructor(name as string)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 12.3 Yes No No No No
Function: Initializes a new printer object given the printer name.
Notes:
Raises exception if lookup fails.
This accepts both CUPS names and the Mac GUI names in printing control panel.

Feedback, Comments & Corrections

CPMPrinterMBS.DescriptionURL as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 12.1 Yes No No No No
Function: Returns the description URL for this printer.
Example:
dim session as CPMPrintSessionMBS = NewCPMPrintSessionMBS
dim printer as CPMPrinterMBS = session.CurrentPrinter

MsgBox printer.DescriptionURL
Notes:
Should be the path to a PPD file for a laser printer.
Lasterror is set.

Feedback, Comments & Corrections

CPMPrinterMBS.DeviceURI as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 12.1 Yes No No No No
Function: Hand back the URI of the printer's device.
Example:
dim session as CPMPrintSessionMBS = NewCPMPrintSessionMBS
dim printer as CPMPrinterMBS = session.CurrentPrinter

MsgBox printer.DeviceURI
Notes:
On success returns a CFURLMBS object describing the printer's device.
Lasterror is set.

Feedback, Comments & Corrections

CPMPrinterMBS.DriverCreator as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Returns a 4 letter code for the creator of the printer.
Example:
dim session as CPMPrintSessionMBS = NewCPMPrintSessionMBS
dim printer as CPMPrinterMBS = session.CurrentPrinter

MsgBox "DriverCreator: "+str(printer.DriverCreator)
Notes: Lasterror is set.

Feedback, Comments & Corrections

CPMPrinterMBS.DriverReleaseInfo as CPMVersionMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 15.1 Yes No No No No
Function: Queries printer driver version.

Feedback, Comments & Corrections

CPMPrinterMBS.HostName as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 9.2 Yes No No No No
Function: Hand back the host name of the print server hosting the printer's print queue.
Example:
dim session as CPMPrintSessionMBS = NewCPMPrintSessionMBS
dim printer as CPMPrinterMBS = session.CurrentPrinter

MsgBox "HostName: "+str(printer.HostName)
Notes: Lasterror is set.

Feedback, Comments & Corrections

CPMPrinterMBS.ID as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 9.2 Yes No No No No
Function: Returns the ID of the string.

Feedback, Comments & Corrections

CPMPrinterMBS.IndexedPrinterResolution(index as Integer) as CPMResolutionMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Returns a printer resolution.
Notes:
Lasterror is set.
Index is from 1 to ResolutionCount.

Feedback, Comments & Corrections

CPMPrinterMBS.IsDefault as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 9.2 Yes No No No No
Function: Whether this printer is the default printer.
Example:
dim session as CPMPrintSessionMBS = NewCPMPrintSessionMBS
dim printer as CPMPrinterMBS = session.CurrentPrinter

MsgBox "IsDefault: "+str(printer.IsDefault)

Feedback, Comments & Corrections

CPMPrinterMBS.IsFavorite as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 9.2 Yes No No No No
Function: Return true if the printer is in the user's favorite printer list.
Example:
dim session as CPMPrintSessionMBS = NewCPMPrintSessionMBS
dim printer as CPMPrinterMBS = session.CurrentPrinter

MsgBox "IsFavorite: "+str(printer.IsFavorite)

Feedback, Comments & Corrections

CPMPrinterMBS.IsPostScriptCapable as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Can this printer do postscript?
Example:
dim session as CPMPrintSessionMBS = NewCPMPrintSessionMBS
dim printer as CPMPrinterMBS = session.CurrentPrinter

MsgBox "IsPostScriptCapable: "+str(printer.IsPostScriptCapable)
Notes: Lasterror is set.

Feedback, Comments & Corrections

CPMPrinterMBS.IsPostScriptPrinter as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 9.2 Yes No No No No
Function: If the result is true if the printer is a PostScript printer.
Example:
dim session as CPMPrintSessionMBS = NewCPMPrintSessionMBS
dim printer as CPMPrinterMBS = session.CurrentPrinter

MsgBox "IsPostScriptPrinter: "+str(printer.IsPostScriptPrinter)
Notes: A PostScript printer is one whose driver takes PostScript directly.

Feedback, Comments & Corrections

CPMPrinterMBS.IsRemote as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 9.2 Yes No No No No
Function: Hand back a boolean indicating whether the printer is hosted by remote print server.
Example:
dim session as CPMPrintSessionMBS = NewCPMPrintSessionMBS
dim printer as CPMPrinterMBS = session.CurrentPrinter

MsgBox "IsRemote: "+str(printer.IsRemote)
Notes:
If result is true, the print queue represents a printer hosted and managed by a remote print server.

If result is false, the print queue represents a directly connected printer, a network printer, or a remote printer that is locally managed. Consult the queue's device URI to determine the type of connection that is used to communicate with the printer.

Whether a printer is remote is derived from the CUPS printer-type attribute for the print queue.

Feedback, Comments & Corrections

CPMPrinterMBS.LanguageInfo as CPMLanguageInfoMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Returns language information about the printer.
Notes: Lasterror is set.

Feedback, Comments & Corrections

CPMPrinterMBS.Location as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 9.2 Yes No No No No
Function: Returns the location of the printer.

Feedback, Comments & Corrections

CPMPrinterMBS.MakeAndModelName as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 9.2 Yes No No No No
Function: A string with the name for the model and the maker.
Notes:
Lasterror is set.
Returns "" on any error.

Feedback, Comments & Corrections

CPMPrinterMBS.Name as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 9.2 Yes No No No No
Function: Returns the name of the string.
Example:
dim session as CPMPrintSessionMBS = NewCPMPrintSessionMBS
dim printer as CPMPrinterMBS = session.CurrentPrinter

MsgBox printer.name

Feedback, Comments & Corrections

CPMPrinterMBS.ResolutionCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Returns how much resolutions are supported by the printer.
Notes: Lasterror is set.

Feedback, Comments & Corrections

CPMPrinterMBS.SetDefault
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 9.2 Yes No No No No
Function: Set the default printer for the current user.
Notes:
It is not typical for an application to set the current default printer for the user; the printing system itself takes care of managing the default printer.
This function should be used only in rare circumstances.

Requires Mac OS X 10.5.

Feedback, Comments & Corrections

CPMPrinterMBS.State as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 15.1 Yes No No No No
Function: Queries printer state.
Example:
dim p as CPMPrinterMBS = CPMPrinterMBS.CreateFromPrinterID("Brother_DCP_8085DN")
MsgBox str(p.State)
Notes: Can be kPMPrinterIdle, kPMPrinterProcessing or kPMPrinterStopped.

Feedback, Comments & Corrections

The items on this page are in the following plugins: MBS MacCG Plugin.




Links
MBS FileMaker Plugins