Edit

IActiveDesktop::GetDesktopItemBySource method (shlobj_core.h)

  • Article

Gets a desktop item using its source URL.

Syntax

HRESULT GetDesktopItemBySource(
  [in]      PCWSTR      pwszSource,
  [in, out] LPCOMPONENT pcomp,
            DWORD       dwReserved
);

Parameters

[in] pwszSource

Type: PCWSTR

A pointer to a string that contains the source URL of the desktop item.

[in, out] pcomp

Type: LPCOMPONENT

A pointer to the COMPONENT structure that, when this method returns successfully, receives the details about the desktop item. On entry, the size of the structure must be set.

dwReserved

Type: DWORD

Reserved. Must be set to zero.

Return value

Type: HRESULT

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

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header shlobj_core.h
DLL Shell32.dll (version 4.71 or later)

See also

IActiveDesktop