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

Включает или отключает фон рабочего стола.

Синтаксис

HRESULT Enable(
  [in] BOOL enable
);

Параметры

[in] enable

Значение TRUE , чтобы включить фон рабочего стола, значение FALSE , чтобы отключить его.

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

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

Код возврата Описание
S_FALSE
Обои рабочего стола уже находятся в состоянии, которое вы запрашиваете через этот звонок.
E_FILE_NOT_FOUND
Фон рабочего стола, который будет использоваться при включении фона, отсутствует в ожидаемом расположении. Вызовите SetWallpaper , чтобы указать новый обои.

Комментарии

Обычно этот метод вызывается для отключения фона рабочего стола по соображениям производительности.

Если фон рабочего стола отключен, вместо нее отображается сплошной цвет. Чтобы получить или задать конкретный цвет, используйте методы GetBackgroundColor и SetBackgroundColor .

Примечание Вызов методов IDesktopWallpaper_SetWallpaper или IDesktopWallpaper_SetSlideshow включает фон рабочего стола, даже если он в настоящее время отключен с помощью этого метода.
 

Требования

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

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

IDesktopWallpaper