Compartilhar via


Função EnumPwrSchemes (powrprof.h)

[EnumPwrSchemes está disponível para uso nos sistemas operacionais especificados na seção Requisitos. Ele poderá ser alterado ou ficar indisponível em versões subsequentes. Os aplicativos gravados para o Windows Vista e posteriores devem usar o PowerEnumerate em vez disso.]

Enumera todos os esquemas de energia. Para cada esquema de energia enumerado, a função chama uma função de retorno de chamada com informações sobre o esquema de energia.

Sintaxe

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

Parâmetros

[in] lpfn

Um ponteiro para uma função de retorno de chamada a ser chamada para cada esquema de energia enumerado. Para obter mais informações, consulte Comentários.

[in] lParam

Um valor definido pelo usuário a ser passado para a função de retorno de chamada.

Valor retornado

Se a função for bem-sucedida, o valor retornado será diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Comentários

Para cada esquema de energia enumerado, a função de retorno de chamada é chamada com os seguintes parâmetros:


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

Os parâmetros sName e sDesc são cadeias de caracteres Unicode terminadas em nulo. O parâmetro pp é um ponteiro para uma estrutura POWER_POLICY que contém o esquema de política de energia. Para continuar até que todos os esquemas de energia tenham sido enumerados, a função de retorno de chamada deve retornar TRUE. Para interromper a enumeração, a função de retorno de chamada deve retornar FALSE.

Para obter mais informações sobre como usar PowrProf.h, consulte Esquemas de energia.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho powrprof.h
Biblioteca PowrProf.lib
DLL PowrProf.dll

Confira também

POWER_POLICY

Funções de gerenciamento de energia

Esquemas de energia