IDesktopWallpaper::GetWallpaper 方法 (shobjidl_core.h)
取得目前的桌面桌布。
語法
HRESULT GetWallpaper(
[in] LPCWSTR monitorID,
[out] LPWSTR *wallpaper
);
參數
[in] monitorID
監視器的識別碼。 這個值可以透過 GetMonitorDevicePathAt取得。
此值可以設定為 Null。 在此情況下,如果所有系統的監視器上顯示單一背景圖樣影像,此方法就會成功傳回。 如果此值設定為 Null ,而不同的監視器顯示不同的背景圖樣或投影片正在執行中,則方法會傳回S_FALSE,並在 背景 圖案參數中傳回空字串。
[out] wallpaper
緩衝區指標的位址,當這個方法成功傳回時,會收到背景圖樣影像檔的路徑。 請注意,此影像目前可能顯示在所有系統的監視器上,而不只是 monitorID 參數中指定的監視器。
如果未顯示任何背景圖樣影像,或監視器顯示純色,則此字串會是空的。 如果 方法失敗,字串也會是空的。
傳回值
如果此方法成功,則會傳回 S_OK。 否則,它會傳回 HRESULT 錯誤碼。
需求
最低支援的用戶端 | Windows 8 [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2012 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | shobjidl_core.h (包括 Shobjidl.h) |