SetAppAlarmPath

SetAppAlarmPath is a built-in function that sets the file path of the Alarm sub-folder in the current project.

Syntax

SetAppAlarmPath(strPath)

SetAppAlarmPath ( strPath )

strPath

The new file path.

Make sure the specified file path and name follow the conventions of the target platform. For example, a file path in Windows starts with a drive letter and uses backward slashes as separators (for example, C:\path\to\file), while a file path in Linux starts at the root directory and uses forward slashes as separators (for example, /path/to/file).

To set the file path to a network drive, either map that drive on the local computer or use the appropriate conventions for network drives.

Return value

This function returns one of the following possible values:

Notes

The Alarm sub-folder contains history files saved by the Alarm worksheets in your project. By default, it is located in your project folder at:

<project name>\Alarm\

You can use this function to change the location where those history files are saved. It does not copy existing history files from the default location to the new one, however; it only sets the file path for new history files that are saved after this function is called.

Examples

Set the file path of the Alarm sub-folder:

SetAppAlarmPath("C:\Project\Alarm\")