AnnounceAlarmArg()

Announces arguments for an upcoming alarm of the transferred type. The order of the arguments is determined by the order of the calls as follows:

1. Call: fbMessage.AnnounceAlarmArg(stEvent, 'Argument1', TRUE)

2. Call: fbMessage.AnnounceAlarmArg(stEvent, 'Argument2', TRUE)

3. Call: fbMessage.SendAlarm(stEvent, 'Argument3', TRUE)

In the event text of stEvent, {0} is replaced with 'Argument1', {1} with 'Argument2' and {2} with 'Argument3'. The order of the calls determines which argument is used for which placeholder.

Syntax:

METHOD AnnounceAlarmArg : HRESULT
VAR_INPUT
    stEventEntry:    TcEventEntry; // TcEventEntry that should receive the announced argument
    sString:         STRING(255);  // STRING argument
    bWithConfirm:    BOOL;         // additional flag to set confirm necessity
END_VAR

Inputs

Name	Type	Description
stEventEntry	TcEventEntry	Event from an event configuration.
sString	STRING(255)	Additional information that will be attached to the event.
bWithConfirm	BOOL	The event requires an acknowledgement.

Outputs

Name	Type	Description
AnnounceAlarmArg	HRESULT	Return value with feedback on the success of the execution

Requirements

Development Environment	Target platform	PLC libraries to include
TwinCAT 4026 >= v3.1.4026.16 TwinCAT 4024 >= v3.1.4024.66	PC or CX (x64, x86)	Tc3_PlasticBaseApplication (>= v12.12.0.0)