Please enable JavaScript to view this site.

Function that allows messages to be added directly to the alarm history.

Syntax

i32 ah_log (i32 code [, par1=0] [, par2=0] [, par3=0])

code

Alarm number. Must be within the message validity range (10000-:-12999)

par1

First parameter passed to the message. (optional, default 0)

par2

Second parameter passed to the message. (optional, default 0)

par3

Third parameter passed to the message. (optional, default 0)

Result

Returns:

Value

Description

0 [ACK_OK]

OK result

101 [NACK_ILL_ARGS]

The alarm number is not in the expected range. In this case, alarm 9900 illegal Arg is generated

133 [NACK_NOT_FOUND]

History not enabled

Validity

Rule, Task

Note

The use of the three parameters and/or their relative types depend on how the message was configured

The structure of messages is equivalent to that of alarms (see user_alarm_file for configuration).

 

 

  

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