SHGetFolderLocation.3w

Langue: en

Version: Jun 2009 (debian - 07/07/09)

Section: 3 (Bibliothèques de fonctions)

NAME

SHGetFolderLocation (SHELL32.@)

SYNOPSIS

HRESULT SHGetFolderLocation
 (
  HWND          hwndOwner,
  int           nFolder,
  HANDLE        hToken,
  DWORD         dwReserved,
  LPITEMIDLIST* ppidl
 )

DESCRIPTION

Gets the folder locations from the registry and creates a pidl.

PARAMS

hwndOwner [In] .

nFolder [In] CSIDL_xxxxx.

hToken [In] token representing user, or NULL for current user, or -1 for default user.

dwReserved [In] must be zero.

ppidl [Out] PIDL of a special folder.

RETURNS

Success: S_OK

Failure: Standard OLE-defined error result, S_FALSE or E_INVALIDARG.

NOTES

Creates missing reg keys and directories. Mostly forwards to SHGetFolderPathW, but a few values of nFolder return virtual folders that are handled here.

IMPLEMENTATION

Defined in "shlobj.h".

Implemented in "dlls/shell32/shellpath.c".

Debug channel "shell".