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

現在のデスクトップの壁紙を取得します。

構文

HRESULT GetWallpaper(
  [in]  LPCWSTR monitorID,
  [out] LPWSTR  *wallpaper
);

パラメーター

[in] monitorID

モニターの ID。 この値は 、GetMonitorDevicePathAt を使用して取得できます。

この値は NULL に設定できます。 その場合、システムのすべてのモニターに 1 つの壁紙 イメージが表示されると、 メソッドは正常に返されます。 この値が NULL に設定されていて、異なるモニターで異なる壁紙が表示されている場合、またはスライドショーが実行されている場合、このメソッドは S_FALSEと wallpaper パラメーターに空の文字列を返します。

[out] wallpaper

このメソッドが正常に返されたときに壁紙 イメージ ファイルへのパスを受け取るバッファーへのポインターのアドレス。 このイメージは、 monitorID パラメーターで指定されたモニターだけでなく、システムのすべてのモニターに表示される可能性があることに注意してください。

壁紙イメージが表示されていない場合、またはモニターに純色が表示されている場合、この文字列は空になります。 メソッドが失敗した場合も、文字列は空になります。

戻り値

このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。

要件

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

関連項目

IDesktopWallpaper

IDesktopWallpaper::SetWallpaper