RegFlushKey
The RegFlushKey
function writes all the attributes of the specified open key into the registry.
LONG RegFlushKey(
|
HKEY hKey |
// handle of key to
write |
|
); |
|
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
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
It is not
necessary to call RegFlushKey to change a key. Registry changes are
flushed to disk by the registry using its lazy flusher. Registry changes are
also flushed to disk at system shutdown.
Unlike RegCloseKey,
the RegFlushKey function returns only when all the data has been written
to the registry.
The RegFlushKey
function may also write out parts of or all of the other keys. Calling this
function excessively can have a negative effect on an application s
performance.
An
application should only call RegFlushKey if it requires absolute
certainty that registry changes are on disk. In general, RegFlushKey
rarely, if ever, need be used.
See Also