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.

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. The message resource is optional; therefore, if you call FormatMessage it could fail.

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.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 1.0 and later Winreg.h   Coredll.lib, Fsreg.lib

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

RegCreateKeyEx, RegDeleteKey, RegOpenKeyEx, RegSetValueEx

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.