METHOD GetAlarmsFromStorage : UDINT
Reads alarms from the alarm storage using the filter criteria of the passed IAlarmManagerClient instance. The result will be stored in the array the IAlarmManagerClient instance passed in the call of method RegisterClient. The return value indicates, whether the processing was successful or not: * ERR_OK: Alarms from storage have been read successfully * ERR_NO_OBJECT: Client was not found, has been not yet registered at the alarm manager * ERR_NOTINITIALIZED: No client has been registered at the alarm manager * ERR_NO_ALARM_STORAGE: No access to the alarm storage possible, because no array for
storing alarms from storage has been passed during registering the client
|
InOut:
|
|
Scope
|
Name
|
Type
|
Comment
|
|
Return
|
GetAlarmsFromStorage
|
UDINT
|
|
|
Input
|
itfAlarmManagerClient
|
IAlarmManagerClient
|
The IAlarmManagerClient instance
|
|
iSkipRows
|
INT
|
The number of rows (beginning at the row with the row ID), that have to skipped. This parameter is used to consider the vertical scrolling. After skipping the rows, the row ID parameter contains the row ID of the new start row. In case of scrolling down, this parameter is positive, in case of scrolling up, this parameter has a negative value. If not scrolled this parameter is 0.
|
|
Inout
|
bRowIDValid
|
BOOL
|
A flag indicating, whether the row ID parameter contains a valid row ID. For the 1st query this flag should be FALSE in order to signal, that the query is performed the 1st time and therefore the cursor has to be set at the beginning of the result set.
|
|
diRowID
|
DINT
|
The row ID of the row, where the search has to start. This parameter will also be modified by the function using the parameter
|
|
Output
|
iCountRows
|
INT
|
Returns the effective number of rows, that have been read
|
|