SHRegSetPath function
Applies to: desktop apps only
Takes a file path, replaces folder names with environment strings, and places the resulting string in the registry.
Syntax
LSTATUS SHRegSetPath( __in HKEY hkey, __in LPCTSTR pszSubkey, __in LPCTSTR pszValue, __in LPCTSTR pszPath, DWORD dwFlags );
Parameters
- hkey [in]
-
Type: HKEY
A handle to a key that is currently open, or a registry root key.
- pszSubkey [in]
-
Type: LPCTSTR
A pointer to a null-terminated string containing the name of an existing subkey. If the subkey does not exist, SHRegSetPath will fail.
- pszValue [in]
-
Type: LPCTSTR
A pointer to a null-terminated string with the name of the value to hold the path string.
- pszPath [in]
-
Type: LPCTSTR
A pointer to a null-terminated string with a fully qualified file path.
- dwFlags
-
Type: DWORD
Reserved.
Return value
Type: LSTATUS
Returns ERROR_SUCCESS if successful, or a Windows error code otherwise.
Remarks
For Windows 2000, SHRegSetPath uses PathUnExpandEnvStrings to convert folder names to their corresponding environment string. If any environment variables were substituted, the registry value will be set with the REG_EXPAND_SZ data type. Otherwise, it will be set with the REG_SZ data type.
The following folder paths will be replaced by their equivalent environment string.
| Folder | Environment string |
|---|---|
| The current user's profile folder | %USERPROFILE% |
| The All Users profile folder | %ALLUSERSPROFILE% |
| The Program Files folder | %ProgramFiles% |
| The system root folder | %SystemRoot% |
| The system drive letter | %SystemDrive% |
Note %USERPROFILE% is relative to the user making the call. This function does not work if the user is being impersonated from a service.
The environment variables listed in the above table might not all be set on any particular system. If an environment variable is not set, it will not be unexpanded. In particular, none of these variables are set for the default environment of Windows 95 or Windows 98. The %ProgramFiles% variable is new for Windows 2000, and will typically not be set on Microsoft Windows NT 4.0 systems.
Requirements
|
Minimum supported client | Windows 2000 Professional, Windows XP |
|---|---|
|
Minimum supported server | Windows 2000 Server |
|
Header |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names | SHRegSetPathW (Unicode) and SHRegSetPathA (ANSI) |
Send comments about this topic to Microsoft
Build date: 3/7/2012
