Skip to main content
Version: v4 (Stable)

SetInstructions

SetInstructions(AlarmId AS String/Integer, Instructions AS String[, ToClean As Boolean[, State AS Integer]]) As Integer

Defines in <Instructions> the name of the instruction file associated with the alarm tag identified by <AlarmId>. <AlarmId> can be the numeric object Id of the tag or its alphanumeric identifier depending on the type of the parameter (Integer or String).

The optional parameter <ToClean> indicates, when TRUE, that the file will have to be destroyed when the alarm will be deleted. By default, this parameter is TRUE.

The optional parameter <State> indicates the state to be configured: 0 for alarm (default), 1 for acknowledgment, 2 for reset.

Returns 0 if no error, 6 for an invalid alarm ID.