SHGetSpecialFolderLocation function (shlobj_core.h)

[SHGetSpecialFolderLocation is not supported and may be altered or unavailable in the future. Instead, use SHGetFolderLocation.]

Retrieves a pointer to the ITEMIDLIST structure of a special folder.

Syntax

HRESULT SHGetSpecialFolderLocation(
  [in]  HWND             hwnd,
  [in]  int              csidl,
  [out] PIDLIST_ABSOLUTE *ppidl
);

Parameters

[in] hwnd

Type: HWND

Reserved.

[in] csidl

Type: int

A CSIDL value that identifies the folder of interest.

[out] ppidl

Type: PIDLIST_ABSOLUTE*

A PIDL specifying the folder's ___location relative to the root of the namespace (the desktop). It is the responsibility of the calling application to free the returned IDList by using CoTaskMemFree.

Return value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

See also

SHGetSpecialFolderPath