nf-shlobj_core-iactivedesktop-getwallpaper.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:shlobj_core.IActiveDesktop.GetWallpaper	IActiveDesktop::GetWallpaper (shlobj_core.h)	Gets the current wallpaper.	AD_GETWP_BMP AD_GETWP_IMAGE AD_GETWP_LAST_APPLIED GetWallpaper GetWallpaper method [Legacy Windows Environment Features] GetWallpaper method [Legacy Windows Environment Features] IActiveDesktop interface IActiveDesktop interface [Legacy Windows Environment Features] GetWallpaper method IActiveDesktop.GetWallpaper IActiveDesktop::GetWallpaper _win32_IActiveDesktop_GetWallpaper lwef.iactivedesktop_getwallpaper shell.iactivedesktop_getwallpaper shlobj_core/IActiveDesktop::GetWallpaper	lwef\iactivedesktop_getwallpaper.htm	lwef	b56cf857-5f3c-47f0-a1c2-e578c44c971b	12/05/2018	AD_GETWP_BMP, AD_GETWP_IMAGE, AD_GETWP_LAST_APPLIED, GetWallpaper, GetWallpaper method [Legacy Windows Environment Features], GetWallpaper method [Legacy Windows Environment Features],IActiveDesktop interface, IActiveDesktop interface [Legacy Windows Environment Features],GetWallpaper method, IActiveDesktop.GetWallpaper, IActiveDesktop::GetWallpaper, _win32_IActiveDesktop_GetWallpaper, lwef.iactivedesktop_getwallpaper, shell.iactivedesktop_getwallpaper, shlobj_core/IActiveDesktop::GetWallpaper	shlobj_core.h		Windows	Windows 2000 Professional, Windows XP [desktop apps only]	Windows 2000 Server [desktop apps only]											Shell32.dll (version 4.71 or later)		Windows			19H1	IActiveDesktop::GetWallpaper shlobj_core/IActiveDesktop::GetWallpaper	c++	APIRef kbSyntax	COM	Shell32.dll	IActiveDesktop.GetWallpaper

IActiveDesktop::GetWallpaper

-description

Gets the current wallpaper.

-parameters

-param pwszWallpaper [out]

Type: PWSTR

When this method returns, contains a pointer to a null-terminated, Unicode buffer that contains the file name of the wallpaper.

-param cchWallpaper

Type: UINT

The size of the pwszWallpaper string, in characters.

-param dwFlags

Type: DWORD

The type of wallpaper to get. One of the following values.

AD_GETWP_BMP (0x00000000)

Get a bitmap.

AD_GETWP_IMAGE (0x00000001)

Get an image.

AD_GETWP_LAST_APPLIED (0x00000002)

Get the type of wallpaper that was last applied.

-returns

Type: HRESULT

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