RegistryKey.OpenSubKey Method (String, RegistryKeyPermissionCheck, RegistryRights)

 

Retrieves the specified subkey for read or read/write access, requesting the specified access rights.

Namespace:   Microsoft.Win32
Assembly:  mscorlib (in mscorlib.dll)

[ComVisibleAttribute(false)]
public RegistryKey OpenSubKey(
	string name,
	RegistryKeyPermissionCheck permissionCheck,
	RegistryRights rights
)

Parameters

name
Type: System.String

The name or path of the subkey to create or open.

permissionCheck
Type: Microsoft.Win32.RegistryKeyPermissionCheck

One of the enumeration values that specifies whether the key is opened for read or read/write access.

rights
Type: System.Security.AccessControl.RegistryRights

A bitwise combination of enumeration values that specifies the desired security access.

Return Value

Type: Microsoft.Win32.RegistryKey

The subkey requested, or null if the operation failed.

Exception Condition
ArgumentNullException

name is null

ArgumentException

permissionCheck contains an invalid value.

ObjectDisposedException

The RegistryKey is closed (closed keys cannot be accessed).

SecurityException

rights includes invalid registry rights values.

-or-

The user does not have the requested permissions.

Rather than throwing an exception, this method returns null if the requested key does not exist.

If permissionCheck is RegistryKeyPermissionCheck.ReadWriteSubTree, the key is opened for reading and writing; if permissionCheck is RegistryKeyPermissionCheck.ReadSubTree or RegistryKeyPermissionCheck.Default, the key is opened for reading unless the parent key was opened with RegistryKeyPermissionCheck.ReadWriteSubTree.

The access specified for permissionCheck takes precedence over the access specified for rights. For example, if you specify RegistryKeyPermissionCheck.ReadSubTree for permissionCheck and RegistryRights.WriteKey for rights, an attempt to write to the subkey throws an exception.

In order to use the OpenSubKey method, you must have an instance of the RegistryKey class. To get an instance of RegistryKey, use one of the static members of the Registry class.

RegistryPermission

for the ability to read the specified registry key. Associated enumeration: RegistryPermissionAccess.Read

SecurityPermission

for the ability to access the specified registry key if it is a remote key. Associated enumeration: SecurityPermissionFlag.UnmanagedCode

.NET Framework
Available since 2.0
Return to top
Show: