HOOK_ep_acknowledgeTableFunction()
The system executes the function when you acknowledge a table (when you use the simple configuration). Implement the function in a CONTROL library.
Synopsis
HOOK_ep_acknowledgeTableFunction( string objectName,
int type,
string column_DPE,
string column_Time,
string column_Index,
string column_Confirmable,
int top,
int bottom);
Parameters
| Parameters | Meaning |
|---|---|
| objectName | Name of the object (table), for example, "TABLE1". |
| type |
Type 0 = column DPE (see simple configuration: Acknowledge table, Type 1 = column_DPE, column_Time, column_Index, column_Confirmable, for example, used in the alert screen. See simple configuration: Acknowledge table. |
| column_DPE | Name of the DPE column. |
| column_Time | Name of the time column. |
| column_Index | If several alarms occur at the same time, the index is used. |
| column_confirmable | Can the alert still be acknowledged. |
| top | Rows to acknowledge (Start). |
| bottom | Rows to acknowledge (End). |
Return value
-
Error
Description
The system executes the function when you acknowledge a table (when you use the simple configuration). Implement the function in a CONTROL library. You have to load this CONTROL library in the user interface when you acknowledge an alarm. Use, for example, the LoadCtrlLibs entry in the config.level file to load the CONTROL library.
Example
If you acknowledge an alarm of the data points ExampleDP_Arg1 or ExampleDP_Arg2 and the acknowledgement was successful, the log viewer shows the Debug information (HOOK_isAckable()).
In the same way if you acknowledge and alarm and you used the simple configuration for the table and acknowledge an alarm, the log viewer shows the debug information (HOOK_ep_acknowledgeTableFunction()). Note that you have to implement these functions in a CONTROL library and you have to load the library as mentioned above.
main()
{
dyn_string dps;
dps = makeDynString("ExampleDP_Arg1", "ExampleDP_Arg2");
int a;
HOOK_isAckable(2, dps,a);
//2 = single acknowledgement
//a = 1 if the DPs could be acknowledged
DebugN("DP could be acknowledged if value = 1: ", a);
DebugN("Hook function HOOK_isAckable executed");
HOOK_ep_acknowledgeTableFunction("TABLE1", 0);
/* Name of the table is "TABLE1", type: column DPE (see simple
configuration: Acknowledge table */
DebugN("Hook function HOOK_ep_acknowledgeTableFunction
executed");
}Assignment
Availability
CTRL
