APUFindPrinterInstance() Function

Finds the first instance of the Alarm Printer using the specified printer name or port.

Category

View

Syntax

[Result=] APUFindPrinterInstance(sPrinter, iInstance);

Arguments

sPrinter

The name of the printer for which the instance is to be found.

iInstance

An integer tag that receives the number of the instance.

Remarks

This function returns the instance number to an integer tag as the instance parameter. Use this function to initially obtain the desired instance of an Alarm Printer. The printer name is stored and read from the .alc file. The printer name string match is not case-sensitive. If no instance is found, the function returns 1 as the error code (no instance available) and writes 0 to the integer tag parameter.

Returns an integer error code.

Example

FoundInst is an integer tag that receives the number of the first instance that uses LPT1 as printer name in its associated .alc file.

Status = APUFindPrinterInstance("LPT1", FoundInst);

See Also

APUFindAlarmGroupInstance(), APUFindFileInstance(), APUGetInstanceCount(), APUIsInstanceUsed()