AlarmStorageReader.Read (METH)

METHOD Read : EAlarmStorageReaderErrors

Reads data from the alarm storage.

InOut:

Scope

Name

Type

Comment

Return

Read

EAlarmStorageReaderErrors

A EAlarmStorageReaderErrors value indicating, whether the processing has been completed successfully or not:
  • EAlarmStorageReaderErrors.NoError: Completed successfully

  • EAlarmStorageReaderErrors.WrongParameter: If the IAlarmStorageReaderConsumer instance is invalid

  • EAlarmStorageReaderErrors.AdditionalReadCallRequired: Reading has been completed successfully, but there is

    additional call of method ContinueReading necessary to read the rest of the data

Input

liTimstampFrom

LINT

The timestamp (when the alarm became active) of the 1st alarm

liTimstampTo

LINT

The timestamp of the last alarm

xReadAscending

BOOL

If this parameter is TRUE, then the rows will be returned by “timestamp active” ascending, otherwise descending

itfAlarmStorageReaderConsumer

IAlarmStorageReaderConsumer

An instance of IAlarmStorageReaderConsumer, to which the data read from the alarm storage will be passed.