Функция SetSuspendState (powrprof.h)

Приостанавливает работу системы, отключая питание. В зависимости от параметра Hibernate система переходит в состояние приостановки (спящего режима) или гибернации (S4).

Синтаксис

BOOLEAN SetSuspendState(
  [in] BOOLEAN bHibernate,
  [in] BOOLEAN bForce,
  [in] BOOLEAN bWakeupEventsDisabled
);

Параметры

[in] bHibernate

Если этот параметр имеет значение TRUE, система перейдет в режим гибернации. Если параметр имеет значение FALSE, система приостанавливается.

[in] bForce

Данный параметр не оказывает влияния.

[in] bWakeupEventsDisabled

Если этот параметр имеет значение TRUE, система отключает все события пробуждения. Если параметр имеет значение FALSE, все события пробуждения системы остаются включенными.

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

Если функция выполняется успешно, возвращается ненулевое значение.

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Комментарии

Вызывающий процесс должен иметь привилегию SE_SHUTDOWN_NAME . Чтобы включить привилегию SE_SHUTDOWN_NAME , используйте функцию AdjustTokenPrivileges . Дополнительные сведения см. в разделе Изменение привилегий в токене.

Приложение может использовать SetSuspendState для перехода системы из рабочего состояния в режим ожидания (спящий режим) или при необходимости гибернации (S4). Эта функция аналогична функции SetSystemPowerState .

Дополнительные сведения об использовании PowrProf.h см. в разделе Схемы питания. Сведения о событиях, которые могут разбудить систему, см. в разделе События пробуждения системы.

Требования

Требование Значение
Минимальная версия клиента Windows XP [только классические приложения]
Минимальная версия сервера Windows Server 2003 [только классические приложения]
Целевая платформа Windows
Header powrprof.h
Библиотека PowrProf.lib
DLL PowrProf.dll

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

PBT_APMQUERYSUSPEND

PBT_APMSUSPEND

Функции управления питанием