Sign in Join
FPDoc Onlineexperiment

TPrinter.DoSetPrinter function

Member of TPrinterprotectedIn unit Printers

Performs actions needed to select the specified printer name.

Declaration

pascal
function DoSetPrinter(aName: string): Integer; virtual

Arguments

aName

Printer name to use as the selected print device.

Function result

Ordinal position for the specified printer name, or -1 when not found.

Description

DoSetPrinter is a virtual Integer function used to perform actions needed to set the selected printer to the name specified in aName. The return value contains the ordinal position in Printers where the name is located, or -1 when the specified name was not found.

In TPrinter, DoSetPrinter always returns the value -1. It must be overridden in a descendent class to perform the actions needed for the operating system / widgetset / printer-related technology used in the implementation.

DoSetPrinter is called from the SetPrinter method.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.