AnnounceAlarmRef()

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 (see AnnounceAlarmArg()):
Syntax:
METHOD AnnounceAlarmArg : HRESULT
VAR_INPUT
stEventEntry: TcEventEntry; // TcEventEntry that should receive the announced argument
stEventReference: STRING(255); // Reference event to be inserted as argument
bWithConfirm: BOOL; // additional flag to set confirm necessity
END_VAR
Inputs
Name | Type | Description |
|---|---|---|
stEventEntry | Event from an event configuration. | |
stEventReference | An event to be included as an argument. | |
bWithConfirm | BOOL | The event requires an acknowledgement. |
Outputs
Name | Type | Description |
|---|---|---|
AnnounceAlarmRef | 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.19 | PC or CX (x64, x86) | Tc3_PlasticBaseApplication (>= v12.16.0.0) |