45 lines
2.0 KiB
Markdown
45 lines
2.0 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- Common/DTS.Common/Classes/WindowsFolder/WindowsFolder.cs
|
||
|
|
generated_at: "2026-04-17T16:10:35.131948+00:00"
|
||
|
|
model: "zai-org/GLM-5-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "f5091c5260aad238"
|
||
|
|
---
|
||
|
|
|
||
|
|
# WindowsFolder
|
||
|
|
|
||
|
|
### Purpose
|
||
|
|
Provides utility functionality for opening Windows filesystem folders via Windows Explorer. This module exists to abstract the process of launching Explorer to display specific application directories, such as the Manuals folder, which contains documentation files for the DTS.Suite application.
|
||
|
|
|
||
|
|
### Public Interface
|
||
|
|
|
||
|
|
**`WindowsFolder` (class)**
|
||
|
|
- Static utility class for opening Windows folders.
|
||
|
|
|
||
|
|
**`public static void OpenManualsFolder(string path)`**
|
||
|
|
- Opens Windows Explorer to display the Manuals folder located at the specified path.
|
||
|
|
- Combines the provided `path` with `Constants.ManualsFolder` to construct the full path.
|
||
|
|
- Launches `Constants.WindowsExplorer` as a new process with the constructed path as an argument.
|
||
|
|
|
||
|
|
### Invariants
|
||
|
|
- The `path` parameter must be a valid filesystem path; no validation is performed within the method.
|
||
|
|
- The method assumes the Manuals folder exists within the provided `path` directory.
|
||
|
|
- `Constants.ManualsFolder` and `Constants.WindowsExplorer` must be defined and accessible.
|
||
|
|
|
||
|
|
### Dependencies
|
||
|
|
**This module depends on:**
|
||
|
|
- `System.IO.Path` - for path combination
|
||
|
|
- `System.Diagnostics.Process` and `ProcessStartInfo` - for launching Explorer
|
||
|
|
- `Constants.ManualsFolder` - constant defining the Manuals folder name
|
||
|
|
- `Constants.WindowsExplorer` - constant defining the Explorer executable path
|
||
|
|
|
||
|
|
**What depends on this module:**
|
||
|
|
- Not determinable from source alone.
|
||
|
|
|
||
|
|
### Gotchas
|
||
|
|
- The XML documentation mentions a default path of `C:\DTS\DTS.Suite\(version)\DataPRO\Manuals` but the method relies on the caller to provide the correct base path.
|
||
|
|
- No error handling is present; if the path is invalid or Explorer cannot be started, an exception will propagate to the caller.
|
||
|
|
- The method does not verify the folder exists before attempting to open it.
|
||
|
|
|
||
|
|
---
|