NAME

SHGetFolderPathW  (SHELL32.@)

SYNOPSIS

 HRESULT SHGetFolderPathW
 (
  HWND   hwndOwner,
  int    nFolder,
  HANDLE hToken,
  DWORD  dwFlags,
  LPWSTR pszPath
 )

PARAMS

hwndOwner [In] owner window.
nFolder [In] CSIDL identifying the folder.
hToken [In] access token.
dwFlags [In] which path to return.
pszPath [Out] converted path.

DESCRIPTION

Convert nFolder to path.

RETURNS

Success: S_OK

Failure: standard HRESULT error codes.

NOTES

Most values can be overridden in either HKCU\Software\Microsoft\Windows\CurrentVersion\Explorer\User Shell Folders or in the same location in HKLM. The registry usage is explained by the following tech note:

http://www.Microsoft®.com/windows2000/techinfo/reskit/en-us/default.asp?url=/windows2000/techinfo/reskit/en-us/regentry/36173.asp The "Shell Folders" registry key was used in NT4 and earlier systems. Beginning with Windows® 2000, the "User Shell Folders" key is used, so changes made to it are made to the former key too. This synchronization is done on-demand: not until someone requests the value of one of these paths (by calling one of the SHGet functions) is the value synchronized. Furthermore, as explained here:

http://www.Microsoft®.com/windows2000/techinfo/reskit/en-us/default.asp?url=/windows2000/techinfo/reskit/en-us/regentry/36276.asp the HKCU paths take precedence over the HKLM paths.

IMPLEMENTATION

Defined in "shlobj.h".

Implemented in "dlls/shell32/shellpath.c". source.winehq.org/source/dlls/shell32/shellpath.c

Debug channel "shell".


Copyright © 2008 The Wine Project. All trademarks are the property of their respective owners. Visit WineHQ for license details. Generated Jan 2008.