Метод IDesktopWallpaper::GetWallpaper (shobjidl_core.h)

Получает текущие обои рабочего стола.

Синтаксис

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

Параметры

[in] monitorID

Идентификатор монитора. Это значение можно получить с помощью GetMonitorDevicePathAt.

Этому значению можно присвоить значение NULL. В этом случае, если на всех мониторах системы отображается одно фоновое изображение, метод возвращается успешно. Если для этого значения задано значение NULL и на разных мониторах отображаются разные обои или слайд-шоу выполняется, метод возвращает S_FALSE и пустую строку в параметре wallpaper .

[out] wallpaper

Адрес указателя на буфер, который при успешном возврате этого метода получает путь к файлу фонового изображения. Обратите внимание, что в настоящее время это изображение может отображаться на всех системных мониторах, а не только на мониторе, указанном в параметре monitorID .

Эта строка будет пустой, если изображение обои не отображается или монитор отображает сплошной цвет. Строка также будет пустой при сбое метода.

Возвращаемое значение

Если этот метод завершается успешно, он возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

Требования

   
Минимальная версия клиента Windows 8 [только классические приложения]
Минимальная версия сервера Windows Server 2012 [только классические приложения]
Целевая платформа Windows
Header shobjidl_core.h (включая Shobjidl.h)

См. также раздел

IDesktopWallpaper

IDesktopWallpaper::SetWallpaper