AlarmStorageReader.prvRetrieveLatchVarValue (METH)ΒΆ

METHOD prvRetrieveLatchVarValue : STO.ERROR

Reads the value of a latch variable from the alarm storage and stores it in the passed IAlarmMetaObjectStub3 instance.

InOut:

Scope

Name

Type

Comment

Return

prvRetrieveLatchVarValue

STO.ERROR
A STO.ERROR value indicating the success or failure of the operation:

  • NO_ERROR: In case of success

  • WRONG_PARAMETER: If iWhichLatchVar references to an invalid latch variable

Input

itfDatabaseAccess

IDatabaseAccess

The instance of IDatabaseAccess, that is used to access the database

itfAlarmMetaObjectStub3

IAlarmMetaObjectStub3

An instance of IAlarmMetaObjectStub3, where the values will be stored

usiWhichLatchVar

USINT

The 1-based index of the latch variable.