SHRegCreateUSKey function
Applies to: desktop apps only
Creates or opens a registry subkey in a user-specific subtree (HKEY_CURRENT_USER or HKEY_LOCAL_MACHINE).
Syntax
LSTATUS SHRegCreateUSKey( __in LPCTSTR pszPath, __in REGSAM samDesired, __in_opt HUSKEY hRelativeUSKey, __out PHUSKEY phNewUSKey, __in DWORD dwFlags );
Parameters
- pszPath [in]
-
Type: LPCTSTR
A pointer to a null-terminated string that contains the subkey to be created or opened. If a value with this name is already present in the subkey, it will be opened.
- samDesired [in]
-
Type: REGSAM
The desired security access. For more information on security access, see REGSAM.
- hRelativeUSKey [in, optional]
-
Type: HUSKEY
The key to be used as a base for relative paths. If pszPath is a relative path, the key it specifies will be relative to hRelativeUSKey. If pszPath is an absolute path, set hRelativeUSKey to NULL. The key will then be created under HKEY_LOCAL_MACHINE or HKEY_CURRENT_USER, depending the value of dwFlags.
- phNewUSKey [out]
-
Type: PHUSKEY
A pointer to an HUSKEY that will receive the handle to the new key.
- dwFlags [in]
-
Type: DWORD
The base key under which the key should be opened. This can be one or more of the following values.
SHREGSET_HKCU
-
Create/open the key under HKEY_CURRENT_USER. Only creates a key if it is empty.
SHREGSET_FORCE_HKCU
-
Create/open the key under HKEY_CURRENT_USER. Creates a key even if it is not empty.
SHREGSET_HKLM
-
Create/open the key under HKEY_LOCAL_MACHINE. Only creates a key if it is empty.
SHREGSET_FORCE_HKLM
-
Create/open the key under HKEY_LOCAL_MACHINE. Creates a key even if it is not empty.
SHREGSET_DEFAULT
-
Create/open the key under both HKEY_CURRENT_USER (forced) and HKEY_LOCAL_MACHINE (only if empty). This flag is the equivalent of (SHREGSET_FORCE_HKCU | SHREGSET_HKLM).
Return value
Type: LSTATUS
Returns ERROR_SUCCESS if successful, or a nonzero error code defined in Winerror.h otherwise. You can use the FormatMessage function with the FORMAT_MESSAGE_FROM_SYSTEM flag to retrieve a generic description of the error.
Remarks
If you want to write values to the new key, use SHRegWriteUSValue to write each value, passing the HUSKEY handle that is returned through phNewUSKey. When you have finished, close the user-specific registry key with SHRegCloseUSKey.
Requirements
|
Minimum supported client | Windows 2000 Professional, Windows XP |
|---|---|
|
Minimum supported server | Windows 2000 Server |
|
Header |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names | SHRegCreateUSKeyW (Unicode) and SHRegCreateUSKeyA (ANSI) |
Send comments about this topic to Microsoft
Build date: 3/7/2012
