Función PowerReadDescription (powrprof.h)

Recupera la descripción de la configuración de energía, el subgrupo o el esquema especificados. Si el parámetro SchemeGuid no es NULL , pero los parámetros SubGroupOfPowerSettingsGuid y PowerSettingGuid son NULL, se devolverá la descripción del esquema de energía. Si los parámetros SchemeGuid y SubGroupOfPowerSettingsGuid no son NULL y el parámetro PowerSettingGuid es NULL, se devolverá la descripción del subgrupo. Si los parámetros SchemeGuid, SubGroupOfPowerSettingsGuid y PowerSettingGuid no son NULL, se devolverá la descripción de la configuración de energía.

Sintaxis

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

Este parámetro está reservado para uso futuro y debe establecerse en NULL.

[in, optional] SchemeGuid

Identificador del esquema de energía.

[in, optional] SubGroupOfPowerSettingsGuid

Subgrupo de la configuración de energía. Este parámetro puede ser uno de los siguientes valores definidos en WinNT.h. Use NO_SUBGROUP_GUID para hacer referencia al esquema de energía predeterminado.

Valor	Significado
NO_SUBGROUP_GUID fea3413e-7e05-4911-9a71-700331f1c294	La configuración de este subgrupo forma parte del esquema de energía predeterminado.
GUID_DISK_SUBGROUP 0012ee47-9041-4b5d-9b77-535fba8b1442	La configuración de este subgrupo controla la configuración de administración de energía de las unidades de disco duro del sistema.
GUID_SYSTEM_BUTTON_SUBGROUP 4f971e89-eebd-4455-a8de-9e59040e7347	Configuración de esta configuración de control de subgrupos de los botones de encendido del sistema.
GUID_PROCESSOR_SETTINGS_SUBGROUP 54533251-82be-4824-96c1-47b60b740d00	La configuración de este subgrupo controla la configuración de las características de administración de energía del procesador.
GUID_VIDEO_SUBGROUP 7516b95f-f776-4464-8c53-06167f40cc99	Configuración de esta configuración de control de subgrupos de las características de administración de energía de vídeo.
GUID_BATTERY_SUBGROUP e73a048d-bf27-4f12-9731-8b2076e8891f	La configuración de este subgrupo controla los puntos de viaje y las acciones de alarma de batería.
GUID_SLEEP_SUBGROUP 238C9FA8-0AAD-41ED-83F4-97BE242C8F20	Configuración de esta configuración de suspensión del sistema de control de subgrupos.
GUID_PCIEXPRESS_SETTINGS_SUBGROUP 501a4d13-42af-4429-9fd1-a8218c268e20	La configuración de este subgrupo controla la configuración de PCI Express.

[in, optional] PowerSettingGuid

Identificador de la configuración de energía que se usa.

[out, optional] Buffer

Puntero a un búfer que recibe la descripción. Si este parámetro es NULL, el parámetro BufferSize recibe el tamaño de búfer necesario. Las cadenas devueltas son cadenas anchas (Unicode).

[in, out] BufferSize

Puntero a una variable que contiene el tamaño del búfer al que apunta el parámetro Buffer .

Si el parámetro Buffer es NULL, la función devuelve ERROR_SUCCESS y la variable recibe el tamaño de búfer necesario.

Si el tamaño del búfer especificado no es lo suficientemente grande como para contener los datos solicitados, la función devuelve ERROR_MORE_DATA y la variable recibe el tamaño de búfer necesario.

Valor devuelto

Devuelve ERROR_SUCCESS (cero) si la llamada se realizó correctamente y un valor distinto de cero si se produjo un error en la llamada. Si el tamaño del búfer especificado por el parámetro BufferSize es demasiado pequeño, la función devuelve ERROR_SUCCESS y el DWORD al que apunta el parámetro BufferSize se rellena con el tamaño de búfer necesario.

Requisitos

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

Consulte también

Funciones de administración de energía