Función EnumPwrSchemes (powrprof.h)

[EnumPwrSchemes está disponible para su uso en los sistemas operativos especificados en la sección Requisitos. En versiones posteriores podría modificarse o no estar disponible. Las aplicaciones escritas para Windows Vista y versiones posteriores deben usar PowerEnumerate en su lugar.

Enumera todos los esquemas de energía. Para cada esquema de energía enumerado, la función llama a una función de devolución de llamada con información sobre el esquema de energía.

Sintaxis

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

Parámetros

[in] lpfn

Puntero a una función de devolución de llamada a la que se va a llamar para cada esquema de energía enumerado. Para obtener más información, vea la sección Comentarios.

[in] lParam

Valor definido por el usuario que se va a pasar a la función de devolución de llamada.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Para cada esquema de energía enumerado, se llama a la función de devolución de llamada con los parámetros siguientes:

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
);

Los parámetros sName y sDesc son cadenas Unicode terminadas en null. El parámetro pp es un puntero a una estructura de POWER_POLICY que contiene el esquema de directiva de energía. Para continuar hasta que se hayan enumerado todos los esquemas de energía, la función de devolución de llamada debe devolver TRUE. Para detener la enumeración, la función de devolución de llamada debe devolver FALSE.

Para obtener más información sobre el uso de PowrProf.h, consulte Esquemas de energía.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	powrprof.h
Library	PowrProf.lib
Archivo DLL	PowrProf.dll

Consulte también

POWER_POLICY

Funciones de administración de energía

Esquemas de energía