Функция PowerReadDescription (powrprof.h)

Статья
03/01/2024

Извлекает описание указанного параметра питания, подгруппы или схемы. Если параметр SchemeGuid не имеет значение NULL, но параметры SubGroupOfPowerSettingsGuid и PowerSettingGuid имеют значение NULL, будет возвращено описание схемы управления питанием. Если параметры SchemeGuid и SubGroupOfPowerSettingsGuid не имеют значения NULL , а параметр PowerSettingGuid имеет значение NULL, будет возвращено описание подгруппы. Если параметры SchemeGuid, SubGroupOfPowerSettingsGuid и PowerSettingGuid не имеют значения NULL, будет возвращено описание параметра питания.

Синтаксис

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

Параметры

[in, optional] RootPowerKey

Этот параметр зарезервирован для использования в будущем и должен иметь значение NULL.

[in, optional] SchemeGuid

Идентификатор схемы питания.

[in, optional] SubGroupOfPowerSettingsGuid

Подгруппа параметров питания. Этот параметр может быть одним из следующих значений, определенных в WinNT.h. Используйте NO_SUBGROUP_GUID для ссылки на схему питания по умолчанию.

Значение	Значение
NO_SUBGROUP_GUID fea3413e-7e05-4911-9a71-700331f1c294	Параметры в этой подгруппе являются частью схемы питания по умолчанию.
GUID_DISK_SUBGROUP 0012ee47-9041-4b5d-9b77-535fba8b1442	Параметры в этой подгруппе управляют конфигурацией управления питанием жестких дисков системы.
GUID_SYSTEM_BUTTON_SUBGROUP 4f971e89-eebd-4455-a8de-9e59040e7347	Параметры в этой подгруппе управляют конфигурацией системных кнопок питания.
GUID_PROCESSOR_SETTINGS_SUBGROUP 54533251-82be-4824-96c1-47b60b740d00	Параметры в этой подгруппе управляют конфигурацией функций управления питанием процессора.
GUID_VIDEO_SUBGROUP 7516b95f-f776-4464-8c53-06167f40cc99	Параметры в этой подгруппе управляют конфигурацией функций управления питанием видео.
GUID_BATTERY_SUBGROUP e73a048d-bf27-4f12-9731-8b2076e8891f	Параметры в этой подгруппе управляют точками и действиями сигнала о срабатывании батареи.
GUID_SLEEP_SUBGROUP 238C9FA8-0AAD-41ED-83F4-97BE242C8F20	Параметры в этой подгруппе управляют параметрами спящего режима системы.
GUID_PCIEXPRESS_SETTINGS_SUBGROUP 501a4d13-42af-4429-9fd1-a8218c268e20	Параметры в этой подгруппе управляют параметрами PCI Express.

[in, optional] PowerSettingGuid

Идентификатор используемого параметра питания.

[out, optional] Buffer

Указатель на буфер, получающий описание. Если этот параметр имеет значение NULL, параметр BufferSize получает требуемый размер буфера. Возвращаемые строки являются широкими строками (Юникод).

[in, out] BufferSize

Указатель на переменную, содержащую размер буфера, на который указывает параметр Buffer .

Если параметр Buffer имеет значение NULL, функция возвращает ERROR_SUCCESS, а переменная получает требуемый размер буфера.

Если указанный размер буфера недостаточно велик для хранения запрошенных данных, функция возвращает ERROR_MORE_DATA , а переменная получает требуемый размер буфера.

Возвращаемое значение

Возвращает ERROR_SUCCESS (ноль), если вызов был выполнен успешно, и ненулевое значение, если вызов завершился неудачно. Если размер буфера, заданный параметром BufferSize , слишком мал, функция возвращает ERROR_SUCCESS , а параметр DWORD , на который указывает параметр BufferSize , заполняется требуемым размером буфера.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Целевая платформа	Windows
Header	powrprof.h
Библиотека	PowrProf.lib
DLL	PowrProf.dll

См. также раздел

Функции управления питанием

Поделиться через