SHRegSetPath function

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.

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