XenoGuard 4.0 Documentation

Get Root Path

ActionStep Reference » Logging » Get Root Path

The Get Root Path ActionStep returns the main or root directory path where the logging files are stored. This can be useful to know where the log files are physically located on the storage medium, and to ensure that they are stored in a secure place.

[-] Hide
  1. Open the Logging node in the Workspace Explorer.
  2. In the Logging node, select the Get Root Path ActionStep.

Parameters:

The ActionStep has no input parameters:

Results:

The ActionStep returns no results:

Information Please make sure that you activate the Logging option in the XenoGuard ribbon menu.

Example 1 (Path Initialization with Get Root Path ActionStep):

This example demonstrates the initial setup process for logging with the Get Root Path ActionStep in XenoGuard. The script begins by defining an index variable and then uses Get Root Path to ascertain the root directory for the logging operation, storing the path in the result list. If the retrieval of the root path fails, the script will state "Failed" and could potentially halt further actions. However, upon successful acquisition of the root path, the script proceeds to create three text streams, setting the stage for subsequent logging activities. These streams are used for organizing log output, which will be written to specific files within the acquired root directory.


See other operations:

Create Text Stream
Write Text Stream
Create Sub Path
Start New Log File