IDesktopWallpaper::GetWallpaper-Methode (shobjidl_core.h)

Ruft das aktuelle Desktophintergrundbild ab.

Syntax

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

Parameter

[in] monitorID

Die ID des Monitors. Dieser Wert kann über GetMonitorDevicePathAt abgerufen werden.

Dieser Wert kann auf NULL festgelegt werden. Wenn in diesem Fall ein einzelnes Hintergrundbild auf allen Monitoren des Systems angezeigt wird, wird die Methode erfolgreich zurückgegeben. Wenn dieser Wert auf NULL festgelegt ist und verschiedene Monitore unterschiedliche Hintergrundbilder anzeigen oder eine Diashow ausgeführt wird, gibt die Methode S_FALSE und eine leere Zeichenfolge im Hintergrundbildparameter zurück.

[out] wallpaper

Die Adresse eines Zeigers auf einen Puffer, der bei erfolgreicher Rückgabe dieser Methode den Pfad zur Hintergrundbilddatei empfängt. Beachten Sie, dass dieses Bild derzeit auf allen Monitoren des Systems angezeigt werden kann, nicht nur auf dem Monitor, der im monitorID-Parameter angegeben ist.

Diese Zeichenfolge ist leer, wenn kein Hintergrundbild angezeigt wird oder ein Monitor eine Volltonfarbe anzeigt. Die Zeichenfolge ist auch leer, wenn die Methode fehlschlägt.

Rückgabewert

Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Anforderungen

Unterstützte Mindestversion (Client)	Windows 8 [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2012 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	shobjidl_core.h (einschließlich Shobjidl.h)

Weitere Informationen

IDesktopWallpaper

IDesktopWallpaper::SetWallpaper