APUFindAlarmGroupInstance() Function

Returns the first instance of the Alarm Printer using the specified alarm group string.

Category

View

Syntax

[Result=] APUFindAlarmGroupInstance(sGroup, iInstance);

Arguments

sGroup

The name of the alarm group to be found among the instances.

iInstance

An integer tag that receives the value of a found instance that uses the specified group name.

Remarks

This function returns the instance number to an integer tag as the instance parameter. The initial alarm group string is read from the .alc file. 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

FoundInstance is an integer tag that receives the number of the first instance found that uses the $System as its query.

Status = APUFindAlarmGroupInstance("$System", FoundInstance);

See Also

APUFindFileInstance(), APUFindPrinterInstance(), APUGetInstanceCount(), APUIsInstanceUsed()