getUserDataDirectory

getUserDataDirectory(): String;

The getUserDataDirectory method of the Node class returns a string containing the path of the user data directory. The user data directory is used for files that are specific to each user of the JADE executables; for example, if a presentation client installation occurs on a Windows machine running Citrix or Terminal Services and all users run the same thin client binaries, any data created on the client file system should be stored under this directory (that is, in separate directories for each user).

If JADE is not installed under the \Program Files directory, the location of the JADE HOME directory is returned.

If JADE is installed under the \Program Files directory, the value that is returned depends on the value of the UserDataDirectory parameter in the [JadeEnvironment] section of the JADE initialization file. If the directory does not exist, JADE creates it.

The values of the UserDataDirectory parameter and the corresponding values returned by the getUserDataDirectory method are shown in the following table.

UserDataDirectory Value	Return Value
<default>	The path of the JADE HOME directory with the \Program Files portion replaced with the programmatically obtained path for the specific user application private data directory. For example, a presentation client installed into \Program Files\Jade Software\parsys and executed by user wilbur returns \Users\wilbur\AppData\Local\Jade Software\parsys.
<homedir>	The path of the JADE HOME directory.
<userdata>	The same as for <default>.
Directory name	Directory name.