RegCloseKey

This function releases the handle of the specified key. A remote application interface (RAPI) version of this function exists, and it is called CeRegCloseKey.

At a Glance

Header file: Winreg.h
Windows CE versions: 1.0 and later

Syntax

LONG RegCloseKey( HKEY hKey );

Parameters

hKey

[in] Handle to the open key to close.

Return Values

ERROR_SUCCESS indicates success. A nonzero error code defined in Winerror.h indicates failure. To get a generic description of the error, call FormatMessage with the FORMAT_MESSAGE_FROM_SYSTEM flag set.

Remarks

The handle for a specified key should not be used after it has been closed, because it will no longer be valid. Key handles should not be left open any longer than necessary.

The RegCloseKey function always writes information to the registry before returning, eliminating the need to flush keys in the Windows CE registry.

See Also

RegCreateKeyEx, RegDeleteKey, RegOpenKeyEx, RegSetValueEx