APUGetPrinterJobCount() Function

Returns the most recent Windows printer status job count for the printer used by this instance.

Category

View

Syntax

[Result=] APUGetPrinterJobCount(iInstance, iTagCount);

Arguments

iInstance

The instance of Alarm Printer (0 to 15).

iTagCount

An integer tag that receives the count value.

Remarks

This function returns the count value in the iTagCount parameter, which is an integer tag.

The results are not current unless a query is running. The results are not current unless an alarm has been printed - the job count is typically updated when the printer is initially opened, and then each time an alarm line is printed.

The returned job count value is only valid for Windows printers and does not have much meaning for printers associated with a parallel or serial port.

Returns an integer error code.

Example

PJCount is an integer tag that receives the count value from the specified instance.

Status = APUGetPrinterJobCount(Inst, PJCount);

See Also

APUGetAlarmGroupText(), APUGetConfigurationFilePath(), APUGetQueryAlarmState(), APUGetQueryFromPriority(), APUGetQueryProcessingState(), APUGetQueryToPriority()