APUGetPrinterName() Function

Returns the Windows printer name or port name of the printer used by this instance.

Category

View

Syntax

[Result=] APUGetPrinterName(iInstance, sTagPrinter);

Arguments

iInstance

The number of the Alarm Printer instance (0 to 15).

sTagPrinter

A message tag that receives the printer name or port name of the configuration associated with the specified instance.

Remarks

This function returns the value NONE if no printer is configured for an instance. The printer name is stored and read from the .alc file. This function returns the printer name or port name to a message tag as the sTagPrinter parameter.

Returns an integer error code.

Example

PrtName is a message tag that receives the printer name or port name of the configuration associated with instance 3 of Alarm Printer.

Status = APUGetPrinterName(3,PrtName);

See Also

APUGetPrinterStatus()