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

[EnumPwrSchemes доступно для использования в операционных системах, указанных в разделе Требования. В последующих версиях он может быть изменен или недоступен. Приложения, написанные для Windows Vista и более поздних версий, должны использовать PowerEnumerate .]

Перечисляет все схемы управления питанием. Для каждой перечисленной схемы питания функция вызывает функцию обратного вызова со сведениями о схеме питания.

Синтаксис

BOOLEAN EnumPwrSchemes(
  [in] PWRSCHEMESENUMPROC lpfn,
  [in] LPARAM             lParam
);

Параметры

[in] lpfn

Указатель на функцию обратного вызова, вызываемую для каждой перечисленной схемы управления питанием. Дополнительные сведения см. в подразделе "Примечания".

[in] lParam

Определяемое пользователем значение, передаваемое функции обратного вызова.

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

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

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

Комментарии

Для каждой перечисленной схемы управления вызывается функция обратного вызова со следующими параметрами:


typedef BOOLEAN (CALLBACK* PWRSCHEMESENUMPROC)(
  UINT uiIndex,      // power scheme index
  DWORD dwName,      // size of the sName string, in bytes
  LPWSTR sName,      // name of the power scheme
  DWORD dwDesc,      // size of the sDesc string, in bytes
  LPWSTR sDesc,      // description string
  PPOWER_POLICY pp,  // receives the power policy
  LPARAM lParam      // user-defined value
);

Параметры sName и sDesc являются строками Юникода с пустым завершением. Параметр pp является указателем на структуру POWER_POLICY , содержащую схему политики управления питанием. Чтобы продолжить работу до перечисления всех схем питания, функция обратного вызова должна возвращать значение TRUE. Чтобы остановить перечисление, функция обратного вызова должна возвращать значение FALSE.

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

Требования

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

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

POWER_POLICY

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

Схемы питания