APUSetQueryAlarmState() Function

Sets the alarm state for the query.

Category

View

Syntax

[Result=] APUSetQueryAlarmState(iInstance, iState);

Arguments

iInstance

The instance of Alarm Printer (0 to 15).

iState

An integer with following possible values:

0 = All

1 = Acknowledged

2 = Unacknowledged

Remarks

A query cannot be running simultaneously while running a script using the APUSetQueryAlarmState() function.

Returns an integer error code.

Example

This example sets the query of the Alarm Printer instance 3 to query for acknowledged alarms only.

Status = APUSetQueryAlarmState(3, 1);

See Also

APUSetAlarmGroupText(), APUSetQueryFromPriority(), APUSetQueryToPriority(), APUSetTimeoutValues()