This function provides information about the alarms stored in the alarm history with return of the information in a variable of type string.
Syntax |
i32 ah_get_s (i32 ahId, string str [, i32 lenMax=str]) |
||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ahId |
Number of the ID of the alarm about which you want information (this kind of information is obtained with ah_info()) |
||||||||||||
str |
Name of the variable of type string |
||||||||||||
lenMax |
Maximum length of the string. (optional, defaults to the size of the string variable str) |
||||||||||||
Result |
Returns:
|
||||||||||||
Validity |
Rule, Task |
||||||||||||
Note |
If the result is positive, the string obtained has the following format : "n - d(dd) m(mm) y(yyyy) hh:ii:ss alarmText".
Parameter |
Description |
|---|---|
n |
Id of the alarm (only the necessary digits) |
dd |
Day |
mm |
Month |
yyyy |
Year |
hh |
Time |
ii |
Minute |
ss |
Seconds |
alarmText |
Text of the alarm |
Note: You can customize the date and time format via the predefined variable date_format.
Example usage:
|
