SaveAlarmFile
- Last UpdatedOct 29, 2026
- 1 minute read
Use this function to enable/disable the saving feature for alarm history and to set the path where the alarm history files must be handled.
|
Function |
Group |
Execution |
String Exp. |
Windows |
Windows Embedded |
IoT View |
Thin Clients |
Mobile Access |
|---|---|---|---|---|---|---|---|---|
|
SaveAlarmFile |
System Info |
Synchronous |
No |
Supported |
Supported |
Not supported |
Not supported |
Not supported |
Syntax
SaveAlarmFile( numType, optRemotePath )
numType
Tag containing the number and operation, as follows:
|
0 |
Disable save the alarm file to the local disk |
|
1 |
Enable save the alarm file to local disk |
|
2 |
Enable save the alarm file to local disk and to the remote path specified in the OptRemotePath parameter |
optRemotePath
Tag containing the name of the remote computer where the alarm file will be saved simultaneously to the local computer and to the remote path when numType equals 2.
Returned value
|
0 |
Success |
|
1 |
2nd parameter is not a string |
|
2 |
2nd parameter is missing |
Examples
|
Tag Name |
Expression |
|---|---|
|
Tag |
SaveAlarmFile( 0 ) |
|
Tag |
SaveAlarmFile( 1 ) |
|
Rag |
SaveAlarmFile( 2, "Z:\Apps\AppDemo" ) |