IDesktopWallpaper::Enable メソッド (shobjidl_core.h)

デスクトップの背景を有効または無効にします。

構文

HRESULT Enable(
  [in] BOOL enable
);

[in] enable

デスクトップ の背景を有効にする場合は TRUE、無効にする 場合は FALSE 。

このメソッドは、成功すると S_OK を返します。それ以外の場合は、次のような HRESULT エラーコードが返されます。

リターンコード	説明
S_FALSE	デスクトップの壁紙は、この呼び出しを通じて求めている状態になっています。
E_FILE_NOT_FOUND	背景が有効になっているときに使用されるデスクトップの壁紙が、想定される場所に表示されません。 SetWallpaper を呼び出して、新しい壁紙を指定します。

このメソッドは通常、パフォーマンス上の理由からデスクトップの背景を無効にするために呼び出されます。

デスクトップの背景を無効にすると、その場所に純色が表示されます。特定の色を取得または設定するには、 GetBackgroundColor メソッドと SetBackgroundColor メソッドを使用します。

メモIDesktopWallpaper_SetWallpaper メソッドまたは IDesktopWallpaper_SetSlideshow メソッドを呼び出すと、このメソッドによって現在無効になっている場合でも、デスクトップの背景が有効になります。

要件	値
サポートされている最小のクライアント	Windows 8 [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2012 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	shobjidl_core.h (Shobjidl.h を含む)