IDesktopWallpaper::Enable 方法 (shobjidl_core.h)

启用或禁用桌面背景。

语法

HRESULT Enable(
  [in] BOOL enable
);

参数

[in] enable

如果为 TRUE ,则启用桌面背景; 如果为 FALSE ,则禁用它。

返回值

如果该方法成功,则返回 S_OK。 否则,它将返回 HRESULT 错误代码,包括以下内容。

返回代码 说明
S_FALSE
桌面壁纸已处于你通过此调用请求的状态。
E_FILE_NOT_FOUND
启用背景时将使用的桌面壁纸从其预期位置缺失。 调用 SetWallpaper 以指定新壁纸。

注解

出于性能原因,通常会调用此方法来禁用桌面后台。

禁用桌面背景时,将在其位置显示纯色。 若要获取或设置特定颜色,请使用 GetBackgroundColorSetBackgroundColor 方法。

注意 调用 IDesktopWallpaper_SetWallpaperIDesktopWallpaper_SetSlideshow 方法将启用桌面背景,即使它当前通过此方法被禁用。
 

要求

要求
最低受支持的客户端 Windows 8 [仅限桌面应用]
最低受支持的服务器 Windows Server 2012 [仅限桌面应用]
目标平台 Windows
标头 shobjidl_core.h (包括 Shobjidl.h)

另请参阅

IDesktopWallpaper