RegSaveKey
The RegSaveKey
function saves the specified key and all of its subkeys and values to a new
file.
LONG RegSaveKey(
|
HKEY hKey, |
// handle of key
where save begins |
|
LPCTSTR lpFile, |
// address of
filename to save to |
|
LPSECURITY_ATTRIBUTES lpSecurityAttributes |
// address of
security structure |
|
); |
|
Parameters
hKey
Specifies a
handle of the key where the save operation is to begin, or any of the following
predefined reserved handle values:
HKEY_CLASSES_ROOT
HKEY_CURRENT_USER
HKEY_LOCAL_MACHINE
HKEY_USERS
lpFile
Points to a
null-terminated string containing the name of the file in which the specified
key and subkeys are saved. This file cannot already exist. If this filename
includes an extension, it cannot be used on file allocation table (FAT) file
systems by the RegLoadKey,
RegReplaceKey,
or RegRestoreKey
function.
lpSecurityAttributes
Windows
NT: Pointer to a SECURITY_ATTRIBUTES structure that specifies a
security descriptor for the new file. If lpSecurityAttributes is NULL,
the file gets a default security descriptor.
Windows
95: This parameter is ignored.
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 hKey
represents a key on a remote computer, the path described by lpFile is
relative to the remote computer.
The RegSaveKey
function saves only nonvolatile keys. It does not save volatile keys. A key is
made volatile or nonvolatile at its creation; see RegCreateKeyEx.
Windows
NT: The calling process must have the
SE_BACKUP_NAME privilege. For more information about privileges, see Privileges.
Windows
95: Security privileges are not
supported or required.
See Also