Função PowerReadDescription (powrprof.h)

Artigo
03/01/2024

Recupera a descrição da configuração de energia, subgrupo ou esquema especificado. Se o parâmetro SchemeGuid não for NULL , mas os parâmetros SubGroupOfPowerSettingsGuid e PowerSettingGuid forem NULL, a descrição do esquema de energia será retornada. Se os parâmetros SchemeGuid e SubGroupOfPowerSettingsGuid não forem NULL e o parâmetro PowerSettingGuid for NULL, a descrição do subgrupo será retornada. Se os parâmetros SchemeGuid, SubGroupOfPowerSettingsGuid e PowerSettingGuid não forem NULL, a descrição da configuração de energia será retornada.

Sintaxe

DWORD PowerReadDescription(
  [in, optional]  HKEY       RootPowerKey,
  [in, optional]  const GUID *SchemeGuid,
  [in, optional]  const GUID *SubGroupOfPowerSettingsGuid,
  [in, optional]  const GUID *PowerSettingGuid,
  [out, optional] PUCHAR     Buffer,
  [in, out]       LPDWORD    BufferSize
);

Parâmetros

[in, optional] RootPowerKey

Esse parâmetro é reservado para uso futuro e deve ser definido como NULL.

[in, optional] SchemeGuid

O identificador do esquema de energia.

[in, optional] SubGroupOfPowerSettingsGuid

O subgrupo de configurações de energia. Esse parâmetro pode ser um dos seguintes valores definidos em WinNT.h. Use NO_SUBGROUP_GUID para se referir ao esquema de energia padrão.

Valor	Significado
NO_SUBGROUP_GUID fea3413e-7e05-4911-9a71-700331f1c294	As configurações nesse subgrupo fazem parte do esquema de energia padrão.
GUID_DISK_SUBGROUP 0012ee47-9041-4b5d-9b77-535fba8b1442	As configurações nesse subgrupo controlam a configuração de gerenciamento de energia das unidades de disco rígido do sistema.
GUID_SYSTEM_BUTTON_SUBGROUP 4f971e89-eebd-4455-a8de-9e59040e7347	As configurações neste subgrupo controlam a configuração dos botões de energia do sistema.
GUID_PROCESSOR_SETTINGS_SUBGROUP 54533251-82be-4824-96c1-47b60b740d00	As configurações neste subgrupo controlam a configuração dos recursos de gerenciamento de energia do processador.
GUID_VIDEO_SUBGROUP 7516b95f-f776-4464-8c53-06167f40cc99	As configurações nesse subgrupo controlam a configuração dos recursos de gerenciamento de energia de vídeo.
GUID_BATTERY_SUBGROUP e73a048d-bf27-4f12-9731-8b2076e8891f	As configurações nesse subgrupo controlam pontos e ações de corrida de alarme de bateria.
GUID_SLEEP_SUBGROUP 238C9FA8-0AAD-41ED-83F4-97BE242C8F20	As configurações neste subgrupo controlam as configurações de suspensão do sistema.
GUID_PCIEXPRESS_SETTINGS_SUBGROUP 501a4d13-42af-4429-9fd1-a8218c268e20	As configurações neste subgrupo controlam as configurações do PCI Express.

[in, optional] PowerSettingGuid

O identificador da configuração de energia que está sendo usada.

[out, optional] Buffer

Um ponteiro para um buffer que recebe a descrição. Se esse parâmetro for NULL, o parâmetro BufferSize receberá o tamanho do buffer necessário. As cadeias de caracteres retornadas são todas cadeias de caracteres largas (Unicode).

[in, out] BufferSize

Um ponteiro para uma variável que contém o tamanho do buffer apontado pelo parâmetro Buffer .

Se o parâmetro Buffer for NULL, a função retornará ERROR_SUCCESS e a variável receberá o tamanho do buffer necessário.

Se o tamanho do buffer especificado não for grande o suficiente para conter os dados solicitados, a função retornará ERROR_MORE_DATA e a variável receberá o tamanho do buffer necessário.

Retornar valor

Retornará ERROR_SUCCESS (zero) se a chamada tiver sido bem-sucedida e um valor diferente de zero se a chamada falhar. Se o tamanho do buffer especificado pelo parâmetro BufferSize for muito pequeno, a função retornará ERROR_SUCCESS e o DWORD apontado pelo parâmetro BufferSize será preenchido com o tamanho do buffer necessário.

Requisitos

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

Confira também

Funções de gerenciamento de energia

Compartilhar via