Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eliahkagan/pfdirs
Find Program Files folders in several ways
https://github.com/eliahkagan/pfdirs
Last synced: about 24 hours ago
JSON representation
Find Program Files folders in several ways
- Host: GitHub
- URL: https://github.com/eliahkagan/pfdirs
- Owner: EliahKagan
- License: 0bsd
- Created: 2024-07-15T18:07:20.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-18T04:19:14.000Z (4 months ago)
- Last Synced: 2024-07-18T06:31:50.015Z (4 months ago)
- Language: Rust
- Size: 28.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pfdirs - Find Program Files folders in several ways
This is Rust program that reports information from multiple sources about where program files directories are located on a Windows system.
## License
[0BSD](LICENSE)
## Sources of information
Details on the source of information, including on subtleties of availability across process and system architectures, are provided [in the code](`src/main.rs`) on the four `report_*` functions that access them. This is a brief summary of the functions:
- **`report_environment_variables()`** uses the `ProgramFiles`, `ProgramFilesW6432`, `ProgramFiles(x86)`, and `ProgramFiles(ARM)` [*environment variables*](https://learn.microsoft.com/en-us/windows/win32/winprog64/wow64-implementation-details#environment-variables).
It calls [`std::env::var()`](https://doc.rust-lang.org/std/env/fn.var.html) which, on Windows, [itself](https://github.com/rust-lang/rust/blob/1.79.0/library/std/src/env.rs#L205-L272) internally [calls](https://github.com/rust-lang/rust/blob/129f3b9964af4d4a709d1383930ade12dfe7c081/library/std/src/sys/pal/windows/os.rs#L296-L303) the [`GetEnvironmentVariableW`](https://learn.microsoft.com/en-us/windows/win32/api/processenv/nf-processenv-getenvironmentvariablew) function.
- **`report_known_folders()`** uses the [`ProgramFiles`](https://learn.microsoft.com/en-us/windows/win32/shell/knownfolderid#FOLDERID_ProgramFiles), [`ProgramFilesX64`](https://learn.microsoft.com/en-us/windows/win32/shell/knownfolderid#FOLDERID_ProgramFilesX64), [`ProgramFilesX86`](https://learn.microsoft.com/en-us/windows/win32/shell/knownfolderid#FOLDERID_ProgramFilesX86), and [`UserProgramFiles`](https://learn.microsoft.com/en-us/windows/win32/shell/knownfolderid#FOLDERID_UserProgramFiles) [*known folders*](https://learn.microsoft.com/en-us/windows/win32/shell/known-folders). (See also [these remarks](https://learn.microsoft.com/en-us/windows/win32/shell/knownfolderid#remarks).)
It calls [`SHGetKnownFolderPath`](https://learn.microsoft.com/en-us/windows/win32/api/shlobj_core/nf-shlobj_core-shgetknownfolderpath) in the Windows API using the [`windows`](https://crates.io/crates/known-folders) crate, which allows detailed errors to be reported, and for demonstration purposes also calls and checks those results against the [`get_known_folder_path()`](https://docs.rs/known-folders/1.1.0/known_folders/fn.get_known_folder_path.html) function provided by the [`known-folders`](https://crates.io/crates/known-folders) crate, which is often sufficient.
- **`report_csidl()`** uses the [`CSIDL_PROGRAM_FILES`](https://learn.microsoft.com/en-us/windows/win32/shell/csidl#CSIDL_PROGRAM_FILES) and [`CSIDL_PROGRAM_FILESX86`](https://learn.microsoft.com/en-us/windows/win32/shell/csidl#CSIDL_PROGRAM_FILESX86) [*CSIDLs*](https://learn.microsoft.com/en-us/windows/win32/shell/csidl), though this should not usually be done because CSIDLs are [superseded](https://learn.microsoft.com/en-us/windows/win32/shell/csidl#remarks) by known folders.
It calls [`SHGetFolderPathW`](https://learn.microsoft.com/en-us/windows/win32/api/shlobj_core/nf-shlobj_core-shgetfolderpathw) in the Windows API using the [`windows`](https://crates.io/crates/known-folders) crate.
- **`report_all_registry_views()`** (see also **`report_registry_view()`**) uses the `ProgramFilesDir`, `ProgramW6432Dir`, `ProgramFilesDir (x86)`, and `ProgramFilesDir (Arm)` *registry keys* in `HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion`, showing their values when accessed through the default view of the registry that depends on the process architecture, as well as when [explicitly specifying](https://learn.microsoft.com/en-us/windows/win32/winprog64/accessing-an-alternate-registry-view) the 32-bit view with `KEY_WOW64_32KEY` or the 64-bit view with `KEY_WOW64_64KEY`.
It calls [`RegKey::open_subkey_with_flags`](https://docs.rs/winreg/0.52.0/winreg/reg_key/struct.RegKey.html#method.open_subkey_with_flags) in the [`winreg`](https://crates.io/crates/winreg) crate, which [itself calls](https://docs.rs/winreg/0.52.0/src/winreg/reg_key.rs.html#164-177) the [`RegOpenKeyExW`](https://learn.microsoft.com/en-us/windows/win32/api/winreg/nf-winreg-regopenkeyexw) function.
## Examples
### A 32-bit (x86) process running on a 64-bit (x64) system
```text
C:\Users\ek\source\repos\pfdirs [main ≡]> cargo run --target=i686-pc-windows-msvc
Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.07s
Running `target\i686-pc-windows-msvc\debug\pfdirs.exe`
Relevant environment variables:
ProgramFiles C:\Program Files (x86)
ProgramFiles(Arm) [environment variable not found]
ProgramFiles(x86) C:\Program Files (x86)
ProgramW6432 C:\Program Files
Relevant known folders:
FOLDERID_ProgramFiles C:\Program Files (x86)
FOLDERID_ProgramFilesX64 [The system cannot find the file specified. (0x80070002)]
FOLDERID_ProgramFilesX86 C:\Program Files (x86)
FOLDERID_UserProgramFiles C:\Users\ek\AppData\Local\Programs
Relevant CSIDLs:
CSIDL_PROGRAM_FILES C:\Program Files (x86)
CSIDL_PROGRAM_FILESX86 C:\Program Files (x86)
Relevant registry keys - with default view:
ProgramFilesDir C:\Program Files (x86)
ProgramFilesDir (Arm) [The system cannot find the file specified. (os error 2)]
ProgramFilesDir (x86) C:\Program Files (x86)
ProgramW6432Dir C:\Program Files
Relevant registry keys - with KEY_WOW64_32KEY:
ProgramFilesDir C:\Program Files (x86)
ProgramFilesDir (Arm) [The system cannot find the file specified. (os error 2)]
ProgramFilesDir (x86) C:\Program Files (x86)
ProgramW6432Dir C:\Program Files
Relevant registry keys - with KEY_WOW64_64KEY:
ProgramFilesDir C:\Program Files
ProgramFilesDir (Arm) [The system cannot find the file specified. (os error 2)]
ProgramFilesDir (x86) C:\Program Files (x86)
ProgramW6432Dir C:\Program Files
```
This shows, among other things, that, [as documented](https://learn.microsoft.com/en-us/windows/win32/shell/knownfolderid#remarks), the [`ProgramFilesX64`](https://learn.microsoft.com/en-us/windows/win32/shell/knownfolderid#FOLDERID_ProgramFilesX64) known folder information is not available to a 32-bit process, even when it is running on a 64-bit system.
### An ARM64 process running natively on an ARM64 system
```text
PS C:\Users\pickens\repos\pfdirs> cargo run
Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.06s
Running `target\debug\pfdirs.exe`
Relevant environment variables:
ProgramFiles C:\Program Files
ProgramFiles(Arm) C:\Program Files (Arm)
ProgramFiles(x86) C:\Program Files (x86)
ProgramW6432 C:\Program Files
Relevant known folders:
FOLDERID_ProgramFiles C:\Program Files
FOLDERID_ProgramFilesX64 C:\Program Files
FOLDERID_ProgramFilesX86 C:\Program Files (x86)
FOLDERID_UserProgramFiles C:\Users\pickens\AppData\Local\Programs
Relevant CSIDLs:
CSIDL_PROGRAM_FILES C:\Program Files
CSIDL_PROGRAM_FILESX86 C:\Program Files (x86)
Relevant registry keys - with default view:
ProgramFilesDir C:\Program Files
ProgramFilesDir (Arm) C:\Program Files (Arm)
ProgramFilesDir (x86) C:\Program Files (x86)
ProgramW6432Dir C:\Program Files
Relevant registry keys - with KEY_WOW64_32KEY:
ProgramFilesDir C:\Program Files (x86)
ProgramFilesDir (Arm) [The system cannot find the file specified. (os error 2)]
ProgramFilesDir (x86) C:\Program Files (x86)
ProgramW6432Dir C:\Program Files
Relevant registry keys - with KEY_WOW64_64KEY:
ProgramFilesDir C:\Program Files
ProgramFilesDir (Arm) C:\Program Files (Arm)
ProgramFilesDir (x86) C:\Program Files (x86)
ProgramW6432Dir C:\Program Files
```