AlarmStorageGetDefaultText (FUN)ΒΆ

FUNCTION AlarmStorageGetDefaultText : CharBufferPtr

This function can be used to determine the default text of a message of an alarm, that was read from the alarm storage. Please remark: This function is accessing localization information and is therefore not recommended for calls from realtime tasks

InOut:

Scope

Name

Type

Comment

Return

AlarmStorageGetDefaultText

CharBufferPtr

A CharBufferPtr containing the default text. A NULL pointer if the corresponding information cannot be retrieved

Input

udiAlarmGroupId

UDINT

The internal id of the alarm group, that was read from the alarm storage

udiAlarmId

UDINT

The internal id of the alarm, that was read from the alarm storage

iWhichMessage

INT

The 1-based index of the text id.

stringType

__SYSTEM.TYPE_CLASS

A __SYSTEM.TYPE_CLASS indicating, which type of string has to be retrieved. Pass either __SYSTEM.TYPE_CLASS.TYPE_STRING or __SYSTEM.TYPE_CLASS.TYPE_WSTRING