RegUnLoadKey
The RegUnLoadKey
function unloads the specified key and subkeys from the registry.
LONG RegUnLoadKey(
|
HKEY hKey, |
// handle of open
key |
|
LPCTSTR lpSubKey |
// address of name
of subkey to unload |
|
); |
|
Parameters
hKey
Specifies the
key to be unloaded. This can be a predefined reserved handle value, or a handle
returned by a call to RegConnectRegistry. The predefined reserved handle values are:
HKEY_LOCAL_MACHINE
HKEY_USERS
lpSubKey
Points to a
null-terminated string containing the name of the subkey to be unloaded. The
key referred to by the lpSubKey parameter must have been created by
using the RegLoadKey function.
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
This function
removes a hive from the registry but does not modify the file containing the
registry information. A hive is a discrete body of keys, subkeys, and values
that is rooted at the top of the registry hierarchy.
Windows
NT: The calling process must have the
SE_RESTORE_NAME privilege. For more information about privileges, see Privileges.
Windows
95: Security privileges are not
supported or required.
See Also