Please enable JavaScript to view this site.

This function allows an alarm with user string variable USV to be added to the alarm stack and alarm history.

The alarm will be added to the stack and history when:

it is not already present in the stack

has a prominent parameter flag imposed and the parameters are different

Syntax

bool alarm_set_us (i32 nAl, i32 nAx, string s1 [, string s2=0] [, string s3=0])

nAl

Alarm number (1000-:-1999, 3000-:-3999, 4000-:-8999)

nAx

Axis number (1-:-32). Put 0 if it is not an axis alarm

s1

First parameter to be entered as user string

s2

Second parameter to be entered as user string. (optional, default 0)

s3

Third parameter to be entered as user string. (optional, default 0)

Result

Returns:

Value

Description

TRUE

alarm generated

alarm disabled

axis not present

FALSE

illegal alarm number

illegal axis number

alarm without USV parameters

Validity

Rule, Task

System Requirements

From RTE 34.30.0

Note


Note: Refer to the user alarm file for alarm text association.

 

  

Keyboard Navigation

F7 for caret browsing
Hold ALT and press letter

This Info: ALT+q
Page Header: ALT+h
Topic Header: ALT+t
Topic Body: ALT+b
Contents: ALT+c
Search: ALT+s
Exit Menu/Up: ESC