Metode IDesktopWallpaper::GetWallpaper (shobjidl_core.h)
Mendapatkan wallpaper desktop saat ini.
Sintaks
HRESULT GetWallpaper(
[in] LPCWSTR monitorID,
[out] LPWSTR *wallpaper
);
Parameter
[in] monitorID
ID monitor. Nilai ini dapat diperoleh melalui GetMonitorDevicePathAt.
Nilai ini dapat diatur ke NULL. Dalam hal ini, jika gambar wallpaper tunggal ditampilkan di semua monitor sistem, metode berhasil dikembalikan. Jika nilai ini diatur ke NULL dan monitor yang berbeda menampilkan wallpaper yang berbeda atau peragaan slide berjalan, metode mengembalikan S_FALSE dan string kosong dalam parameter wallpaper .
[out] wallpaper
Alamat penunjuk ke buffer yang, ketika metode ini berhasil dikembalikan, menerima jalur ke file gambar wallpaper. Perhatikan bahwa gambar ini saat ini dapat ditampilkan pada semua monitor sistem, bukan hanya monitor yang ditentukan dalam parameter monitorID .
String ini akan kosong jika tidak ada gambar wallpaper yang ditampilkan atau jika monitor menampilkan warna solid. String juga akan kosong jika metode gagal.
Mengembalikan nilai
Jika metode ini berhasil, metode ini mengembalikan S_OK. Jika tidak, kode kesalahan HRESULT akan dikembalikan.
Persyaratan
| Klien minimum yang didukung | Windows 8 [hanya aplikasi desktop] |
| Server minimum yang didukung | Windows Server 2012 [hanya aplikasi desktop] |
| Target Platform | Windows |
| Header | shobjidl_core.h (termasuk Shobjidl.h) |