SHGetDesktopFolder function (shlobj_core.h)

Retrieves the IShellFolder interface for the desktop folder, which is the root of the Shell's namespace.

Syntax

SHSTDAPI SHGetDesktopFolder(
  [out] IShellFolder **ppshf
);

Parameters

[out] ppshf

Type: IShellFolder**

When this method returns, receives an IShellFolder interface pointer for the desktop folder. The calling application is responsible for eventually freeing the interface by calling its IUnknown::Release method.

Return value

Type: HRESULT

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

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	shlobj_core.h (include Shlobj.h)
Library	Shell32.lib
DLL	Shell32.dll (version 4.0 or later)