Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function opens the specified registry key on a remote Windows Embedded CE–based device.

Syntax 

LONG CeRegOpenKeyEx( 
  HKEY 
hKey, 
  LPCWSTR 
lpszSubKey, 
  DWORD 
ulOptions, 
  REGSAM 
samDesired, 
  PHKEY 
phkResult 
);

Parameters

hKey

[in] Handle to a currently open key or any of the following predefined reserved handle values:

HKEY_CLASSES_ROOT

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

Windows Embedded CE does not support the HKEY_CURRENT_CONFIG, HKEY_PERFORMANCE_DATA, or HKEY_DYN_DATA predefined reserved handle values.

lpszSubKey

[in] Pointer to a null-terminated string containing the name of the subkey to open. If this parameter is NULL or a pointer to an empty string, the function will open a new handle to the key identified by the hKeyparameter. In this case, the function will not close the handles previously opened.

ulOptions

[in] Reserved; set to 0.

samDesired

[in] Not supported; set to zero.

phkResult

[out] Pointer to a variable that receives a handle to the opened key. When you no longer need the returned handle, call the CeRegCloseKeyfunction to close it.

Return Value

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

Remarks

Unlike the CeRegCreateKeyExfunction, the CeRegOpenKeyExfunction does not create the specified key if the key does not exist in the registry.

Requirements

Header rapi.h
Library rapi.lib
Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Pocket PC 2002 and later, Smartphone 2002 and later

See Also