RegConnectRegistry info  Overview  Group

The RegConnectRegistry function establishes a connection to a predefined registry handle on another computer.

LONG RegConnectRegistry(

Parameters

lpMachineName

Points to a null-terminated string containing the name of the remote computer. The string has the following form:

\\computername

If lpMachineName is NULL, the local computer name is used.

hKey

Specifies the one of the following predefined registry handles on the remote computer.

HKEY_LOCAL_MACHINE
HKEY_USERS
HKEY_PERFORMANCE_DATA, if the remote computer is running Windows NT
Windows 95 only: HKEY_DYN_DATA, if the remote computer is running Windows 95
Windows 95 only: HKEY_CURRENT_CONFIG, if the remote computer is running Windows 95

You cannot specify the HKEY_CLASSES_ROOT or HKEY_CURRENT_USER value for this parameter.

phkResult

Points to a variable that receives a key handle identifying the predefined handle on the remote computer.

Return Values

If the function succeeds, the return value is ERROR_SUCCESS.

If the function fails, the return value is a nonzero error code defined in WINERROR.H. You can use the FormatMessage function with the FORMAT_MESSAGE_FROM_SYSTEM flag to get a generic description of the error.

Remarks

When a handle returned by RegConnectRegistry is no longer needed, it should be closed by calling RegCloseKey. However, this may not terminate the session. To terminate the session, call the WNetCancelConnection2 function with \\server\ipc$ as the name of the resource to disconnect.

See Also

RegCloseKey, WNetCancelConnection2