Changing the location of Client work files
The Debugger Client uses a variety of text files to store information about user activity to maintain its tools and displays, as well as a comprehensive troubleshooting log. These work files are catalogued below.
The Client configuration file (debuggerConfig.xml) has optional XML elements with which you can specify alternative folder locations for the Client work files. The files are divided into three groups, each of which is controlled by a single element, as follows:
- <stateFileFolder> specifies where most Client work files are written (log, preferences, searches, for example)
- <uiFolder> specifies where the Client interface-customization files (ui.xml, uimore.xml) are stored
- <macroLibraryFolder> specifies where Client macro files are stored
Within debuggerConfig.xml, you specify folder path values for the elements as in the following:
<debuggerConfig version="1.0">
...
<stateFileFolder>c:\myData</stateFileFolder>
<uiFolder>c:\myUI</uiFolder>
<macroLibraryFolder>c:\work\macroLibrary</macroLibraryFolder>
...
</debuggerConfig>
If you include an element, the specified folder location is validated when the Client is started, and you receive an error if the folder is missing or not writable. The locations are also reported in the audit trail.
If an element is not specified, the installation target folder is the assumed location. The exception to this is the macroLibraryFolder element: if this element is not specified, the Client will initially attempt to store or find macro files in the stateFileFolder location, else in the Client installation folder. Similarly, if the macroLibraryFolder element is specified, the Client tries that location first, else it tries the stateFileFolder location, else the Client installation folder.
A summary of the Client files
| File (by type) | File content | Configuration file element that specifies file default location |
|---|---|---|
| name.macro | Client macro | macroLibraryFolder |
| excludeProc.txt | The list of procedures to be excluded from debugging | stateFileFolder |
| excludeRoutine.txt | The list of methods and subroutines to be excluded from debugging | stateFileFolder |
| find.txt | The most recent Search terms | stateFileFolder |
| includeProc.txt | The list of procedures not to be excluded from debugging | stateFileFolder |
| includeRoutine.txt | The list of methods and subroutines not to be excluded from debugging | stateFileFolder |
| log.txt | The Debugger Client log | stateFileFolder |
| until.txt | The most recent run-until target procedures | stateFileFolder |
| vars.txt | The most recent entries in the text box above the Watch Window | stateFileFolder |
| watchmemory.txt | The contents of the Watch Window between Client runs (if feature is enabled) | stateFileFolder |
| whitelist.txt | The white list of procedures to omit from debugging | stateFileFolder |
| name.watch | Saved Watch Window lists | stateFileFolder |
| about.xml | The remembered position and size of the Client's About box | stateFileFolder |
| console.xml | The remembered position and size of the Macro Console window | stateFileFolder |
| getVariableList.xml | The remembered position and size of the getVariablesForClass command output window | stateFileFolder |
| history.xml | The remembered position and size of the Execution History window | stateFileFolder |
| preferences.xml | The settings from the Preferences and Color Preferences dialog boxes | stateFileFolder |
| shortcuts.xml | The remembered position and size of the Keyboard Shortcuts window | stateFileFolder |
| textviewer.xml | The remembered position and size of the Text Viewer window | stateFileFolder |
| ui.xml | Modifications to the Client's default buttons and hot key associations | uiFolder |
| uimore.xml | Settings that override the ui.xml file settings | uiFolder |
| valueDisplay.xml | Remembered position and size of Value window displays | stateFileFolder |
| windowmemory.xml | Remembered position and size of the main Debugger Client window | stateFileFolder |
See Also: