RegCreateKeyEx (Windows CE 5.0)

  • Article

Send Feedback

This function creates the specified key. If the key already exists in the registry, the function opens it.

A remote application interface (RAPI) version of this function exists, and it is called CeRegCreateKeyEx (RAPI).

LONGRegCreateKeyEx( HKEYhKey, LPCWSTRlpSubKey, DWORDReserved, LPWSTRlpClass, DWORDdwOptions, REGSAMsamDesired, LPSECURITY_ATTRIBUTESlpSecurityAttributes, PHKEYphkResult, LPDWORDlpdwDisposition );

Parameters

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

    • HKEY_CLASSES_ROOT
    • HKEY_CURRENT_USER
    • HKEY_LOCAL_MACHINE
    • HKEY_USERS

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

    The key opened or created by the RegCreateKeyEx function is a subkey of the key identified by the hKey parameter.

  • lpSubKey
    [in] Pointer to a null-terminated string specifying the name of a subkey that this function opens or creates. The subkey specified must be a subkey of the key identified by the hKey parameter. This subkey must not begin with the backslash character (\). If the parameter is NULL, then RegCreateKeyEx behaves like RegOpenKey where it opens the key specified by hKey. In Windows CE, the maximum length of a key name is 255 characters, not including the terminating NULL character. You can also only nest 16 levels of sub-keys in Windows CE.

  • Reserved
    [in] Reserved; set to 0.

  • lpClass
    [in] Pointer to a null-terminated string that specifies the class (object type) of this key. This parameter is ignored if the key already exists. In Windows CE, the maximum length of a class string is 255 characters, not including the terminating NULL character.

  • dwOptions
    [in] Registry key options. The following table shows the possible values for this parameter.

    Value Description
    REG_OPTION_NON_VOLATILE Default setting. All registry keys are created as non-volatile and the information stored in memory is preserved when the OS is restarted. The RegSaveKey function saves keys that are non-volatile.
    REG_OPTION_VOLATILE All registry keys are created as volatile, and the information is stored in memory and is not preserved when the corresponding registry hive is unloaded. For HKEY_LOCAL_MACHINE, this occurs when the OS is shut down. The RegSaveKey function does not save volatile registry keys. This flag is ignored for keys that already exist.

  • samDesired
    [in] Ignored; set to 0 to ensure compatibility with future versions of Windows CE.

  • lpSecurityAttributes
    [in] Set to NULL. Windows CE automatically assigns the key a default security descriptor.

  • phkResult
    [out] Pointer to a variable that receives a handle to the opened or created key. When you no longer need the returned handle, call the RegCloseKey function to close it.

  • lpdwDisposition
    [out] Pointer to a variable that receives disposition values. The following table shows possible values for this parameter.

    Value Description
    REG_CREATED_NEW_KEY The key did not exist and was created.
    REG_OPENED_EXISTING_KEY The key existed and was simply opened without being changed.

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 key that the RegCreateKeyEx function creates has no values. An application can use the RegSetValueEx function to set key values.

An application can use RegCreateKeyEx to temporarily lock a portion of the registry. When the locking process creates a new key, it receives the disposition value REG_CREATED_NEW_KEY, indicating that it owns the lock. Another process attempting to create the same key receives the disposition value REG_OPENED_EXISTING_KEY, indicating that another process already owns the lock.

Requirements

OS Versions: Windows CE 1.0 and later.
Header: Winreg.h.
Link Library: Coredll.lib.

See Also

RegDeleteKey | RegOpenKeyEx | RegSetValueEx

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.