Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Synopsis
Find a registry key or value.
Important
The registry
command and Microsoft.Windows/Registry
resource are a proof-of-concept example
for use with DSCv3. Don't use it in production.
Syntax
registry find [Options] --key-path <KEY_PATH>
Description
The find
command isn't implemented yet. It returns a string that echoes the specified options.
Options
-k, --key-path
Specifies the registry key path to use as the base for the search. The path must start with a valid
hive identifier. Each segment of the path must be separated by a backslash (\
).
The following table describes the valid hive identifiers for the key path.
Short Name | Long Name | NT Path |
---|---|---|
HKCR |
HKEY_CLASSES_ROOT |
\Registry\Machine\Software\Classes\ |
HKCU |
HKEY_CURRENT_USER |
\Registry\User\<User SID>\ |
HKLM |
HKEY_LOCAL_MACHINE |
\Registry\Machine\ |
HKU |
HKEY_USERS |
\Registry\User\ |
HKCC |
HKEY_CURRENT_CONFIG |
\Registry\Machine\System\CurrentControlSet\Hardware Profiles\Current\ |
Type: String
Mandatory: true
-f, --find
The string to search for in the registry key and value names.
Type: String
Mandatory: true
-r, --recurse
Indicates whether the command should recursively find subkeys and values. By default, the command isn't recursive.
Type: boolean
Mandatory: false
--keys_only
Indicates whether the command should limit results to registry keys. By default, the command returns matching registry keys and values.
Type: boolean
Mandatory: false
--values_only
Indicates whether the command should limit results to registry values. By default, the command returns matching registry keys and values.
Type: boolean
Mandatory: false
-h, --help
Displays the help for the current command or subcommand. When you specify this option, the application ignores all options and arguments after this one.
Type: boolean
Mandatory: false