getProgramDataDirectory

getProgramDataDirectory(): String;

The getProgramDataDirectory method of the Node class returns a string containing the path of the program data directory.

The program data directory is used to share files among the users of the executables; for example, the jommsg.log file or shared dictionary spelling files that are updated.

If JADE is not installed under the \Program Files directory, the path of the JADE HOME directory is returned. If JADE is installed under the \Program Files directory, the value that is returned by the getProgramDataDirectory method depends on the value of the ProgramDataDirectory parameter in the [JadeEnvironment] section of the JADE initialization file.

If the directory does not exist, JADE creates it. The values of the ProgramDataDirectory parameter and the corresponding values returned by the getProgramDataDirectory method are shown in the following table.

ProgramDataDirectory Value Return Value
<default> For a Windows release earlier than Windows 7, Windows Server 2016, or Windows Server 2008, the value returned is the same as for <homedir>. For Windows 10, Windows 8, Windows 7, Windows Server 2012, or Windows Server 2008, the value returned is the same as for <programdata>.
<homedir> The path of the JADE HOME directory.
<programdata> The path of the JADE HOME directory with the \Program Files portion replaced with the programmatically obtained path of the common application data directory. For example, a presentation client installed in \Program Files\Jade Software\parsys returns \Documents and Settings\All Users\Application Data\Jade Software\parsys on a Windows operating system earlier than Windows 7, or Windows Server 2008, or \ProgramData\Jade Software\parsys on Windows 10, Windows 8, Windows 7, Windows Server 2016, Windows Server 2012, or Windows Server 2008.
Directory name Directory name.