| 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:shobjidl_core.IDesktopWallpaper.Enable |
IDesktopWallpaper::Enable (shobjidl_core.h) |
Enables or disables the desktop background. |
|
shell\IDesktopWallpaper_Enable.htm |
shell |
8BC04B93-4BF4-4713-8EF8-C4BCF1C8090E |
12/05/2018 |
Enable, Enable method [Windows Shell], Enable method [Windows Shell],IDesktopWallpaper interface, IDesktopWallpaper interface [Windows Shell],Enable method, IDesktopWallpaper.Enable, IDesktopWallpaper::Enable, shell.IDesktopWallpaper_Enable, shobjidl_core/IDesktopWallpaper::Enable |
shobjidl_core.h |
Shobjidl.h |
Windows |
Windows 8 [desktop apps only] |
Windows Server 2012 [desktop apps only] |
Shobjidl.idl |
Windows |
19H1 |
|
|
|
|
|
|
Enables or disables the desktop background.
TRUE to enable the desktop background, FALSE to disable it.
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code, including the following.
| Return code | Description |
|---|---|
|
The desktop wallpaper is already in the state you're asking for through this call. |
|
The desktop wallpaper that would be used when the background is enabled is missing from its expected location. Call SetWallpaper to specify a new wallpaper. |
This method would normally be called to disable the desktop background for performance reasons.
When the desktop background is disabled, a solid color is shown in its place. To get or set the specific color, use the GetBackgroundColor and SetBackgroundColor methods.
Note A call to the IDesktopWallpaper_SetWallpaper or IDesktopWallpaper_SetSlideshow methods will enable the desktop background even if it is currently disabled through this method.