Função SetActivePwrScheme (powrprof.h)

Artigo
03/05/2024

[SetActivePwrScheme 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 PowerSetActiveScheme em vez disso.]

Define o esquema de energia ativo.

Sintaxe

BOOLEAN SetActivePwrScheme(
  [in]           UINT                 uiID,
  [in, optional] PGLOBAL_POWER_POLICY pGlobalPowerPolicy,
  [in, optional] PPOWER_POLICY        pPowerPolicy
);

Parâmetros

[in] uiID

O índice do esquema de energia a ser ativado.

[in, optional] pGlobalPowerPolicy

Um ponteiro para uma estrutura de GLOBAL_POWER_POLICY opcional, que fornece configurações de política de energia global a serem mescladas com o esquema de energia quando ele se torna ativo.

[in, optional] pPowerPolicy

Um ponteiro para uma estrutura de POWER_POLICY opcional, que fornece configurações de política de energia a serem mescladas com o esquema de energia quando ele se torna ativo.

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

Use essa função para fazer alterações de longo prazo na configuração do sistema. Para manter temporariamente o sistema em execução enquanto um aplicativo está executando uma tarefa, use a função SetThreadExecutionState .

Se o esquema de energia especificado por uiID não existir, a função retornará zero.

Se lpGlobalPowerPolicy for NULL, a função usará as configurações atuais da política de energia global definidas por WriteGlobalPwrPolicy. Caso contrário, as configurações na estrutura especificada substituem as configurações atuais da política de energia global.

Se lpPowerPolicy for NULL, a função usará as configurações atuais de política de energia para o esquema de energia. Caso contrário, as configurações na estrutura especificada substituem as configurações atuais da política de energia.

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