RegistryKey.OpenRemoteBaseKey Method (RegistryHive, String)

Opens a new RegistryKey that represents the requested key on a remote machine.

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

public static RegistryKey OpenRemoteBaseKey(
	RegistryHive hKey,
	string machineName
)

Parameters

hKey
Type: Microsoft.Win32.RegistryHive

The HKEY to open, from the RegistryHive enumeration.

machineName
Type: System.String

The remote machine.

Return Value

Type: Microsoft.Win32.RegistryKey
The requested registry key.

ExceptionCondition
ArgumentException

hKey is invalid.

IOException

machineName is not found.

ArgumentNullException

machineName is null.

SecurityException

The user does not have the proper permissions to perform this operation.

UnauthorizedAccessException

The user does not have the necessary registry rights.

The local machine registry is opened if machineName is String.Empty. The requested key must be a root key on the remote machine, and is identified by the appropriate RegistryHive value.

In order for a key to be opened remotely, both the server and client machines must be running the remote registry service, and have remote administration enabled.

The following code example shows how to open a registry key on a remote computer and enumerate the values of the key. The remote computer must be running the remote registry service. Specify the name of the remote computer as a command-line argument when invoking the program.

using System;
using System.IO;
using System.Security.Permissions;
using Microsoft.Win32;


class RemoteKey
{
    static void Main(string[] args)
    {
        RegistryKey environmentKey;
        string remoteName;

        // Check that an argument was specified when the  
        // program was invoked. 
        if(args.Length == 0)
        {
            Console.WriteLine("Error: The name of the remote " +
                "computer must be specified when the program is " +
                "invoked.");
            return;
        }
        else
        {
            remoteName = args[0];
        }

        try
        {
            // Open HKEY_CURRENT_USER\Environment  
            // on a remote computer.
            environmentKey = RegistryKey.OpenRemoteBaseKey(
                RegistryHive.CurrentUser, remoteName).OpenSubKey(
                "Environment");
        }
        catch(IOException e)
        {
            Console.WriteLine("{0}: {1}", 
                e.GetType().Name, e.Message);
            return;
        }

        // Print the values.
        Console.WriteLine("\nThere are {0} values for {1}.", 
            environmentKey.ValueCount.ToString(), 
            environmentKey.Name);
        foreach(string valueName in environmentKey.GetValueNames())
        {
            Console.WriteLine("{0,-20}: {1}", valueName, 
                environmentKey.GetValue(valueName).ToString());
        }

        // Close the registry key.
        environmentKey.Close();
    }
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft