RegRestoreKey
The RegRestoreKey
function reads the registry information in a specified file and copies it over
the specified key. This registry information may be in the form of a key and
multiple levels of subkeys.
LONG RegRestoreKey(
|
HKEY hKey, |
// handle of key
where restore begins |
|
LPCTSTR lpFile, |
// address of
filename containing saved tree |
|
DWORD dwFlags |
// optional flags |
|
); |
|
Parameters
hKey
Identifies a
currently open key or any of the following predefined reserved handle values:
HKEY_CLASSES_ROOT
HKEY_CURRENT_USER
HKEY_LOCAL_MACHINE
HKEY_USERS
Any information contained in this key and its descendent keys is
overwritten by the information in the file pointed to by the lpFile
parameter.
lpFile
Points to a
null-terminated string containing the name of the file with registry
information. This file is typically created by using the RegSaveKey function. Under the file
allocation table (FAT) file system, the filename may not have an extension.
dwFlags
Specifies a
flag indicating whether the key is volatile. (A volatile key is valid only
until the next time the system is started.) This parameter is optional; if no
value is specified, the key is not volatile.
This parameter can be the REG_WHOLE_HIVE_VOLATILE flag set. Instead of
restoring the given key, this flag causes a new, volatile (memory only) set of
registry information to be created. (A hive is a large set of registry
information, typically containing all of the pertinent information for part of
the system. For example, HKEY_LOCAL_MACHINE\Hardware is a
volatile hive.)
If REG_WHOLE_HIVE_VOLATILE is specified, the key identified by the hKey
parameter must be either the HKEY_USERS or HKEY_LOCAL_MACHINE
value.
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
If any
subkeys of the hKey parameter are open, RegRestoreKey fails. The
function also fails if the calling process does not have the SE_RESTORE_NAME
privilege. For more information about privileges, see Privileges.
This function
replaces the keys and values below the specified key with the keys and values
that are subsidiary to the top-level key in the file, no matter what the name
of the top-level key in the file might be. For example, hKey might
identify a key A with subkeys B and C, while the lpFile
parameter specifies a file containing key X with subkeys Y and Z.
After a call to RegRestoreKey, the registry would contain key A
with subkeys Y and Z. The value entries of A would be
replaced by the value entries of X.
The new
information in the file specified by lpFile overwrites the contents of
the key specified by the hKey parameter, except for the key name.
If hKey
represents a key in a remote computer, the path described by lpFile is
relative to the remote computer.
See Also