PowerReadDescription-Funktion (powrprof.h)

Artikel
08/25/2023

Ruft die Beschreibung für die angegebene Energieeinstellung, Untergruppe oder das angegebene Schema ab. Wenn der SchemeGuid-Parameter nicht NULL ist, aber sowohl die Parameter SubGroupOfPowerSettingsGuid und PowerSettingGuidNULL sind, wird die Beschreibung des Energieschemas zurückgegeben. Wenn die Parameter SchemeGuid und SubGroupOfPowerSettingsGuid nicht NULL und der PowerSettingGuid-ParameterNULL ist, wird die Beschreibung der Untergruppe zurückgegeben. Wenn die Parameter SchemeGuid, SubGroupOfPowerSettingsGuid und PowerSettingGuid nicht NULL sind, wird die Beschreibung der Energieeinstellung zurückgegeben.

Syntax

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

Parameter

[in, optional] RootPowerKey

Dieser Parameter ist für die zukünftige Verwendung reserviert und muss auf NULL festgelegt werden.

[in, optional] SchemeGuid

Der Bezeichner des Energieschemas.

[in, optional] SubGroupOfPowerSettingsGuid

Die Untergruppe der Energieeinstellungen. Dieser Parameter kann einer der folgenden Werte sein, die in WinNT.h definiert sind. Verwenden Sie NO_SUBGROUP_GUID , um auf das Standardenergieschema zu verweisen.

Wert	Bedeutung
NO_SUBGROUP_GUID fea3413e-7e05-4911-9a71-700331f1c294	Einstellungen in dieser Untergruppe sind Teil des Standardenergieschemas.
GUID_DISK_SUBGROUP 0012ee47-9041-4b5d-9b77-535fba8b1442	Einstellungen in dieser Untergruppe steuern die Energieverwaltungskonfiguration der Festplattenlaufwerke des Systems.
GUID_SYSTEM_BUTTON_SUBGROUP 4f971e89-eebd-4455-a8de-9e59040e7347	Einstellungen in dieser Untergruppensteuerungskonfiguration der Netzschalter des Systems.
GUID_PROCESSOR_SETTINGS_SUBGROUP 54533251-82be-4824-96c1-47b60b740d00	Einstellungen in dieser Untergruppe steuern die Konfiguration der Prozessorleistungsverwaltungsfeatures.
GUID_VIDEO_SUBGROUP 7516b95f-f776-4464-8c53-06167f40cc99	Einstellungen in dieser Untergruppe steuern die Konfiguration der Videoenergieverwaltungsfeatures.
GUID_BATTERY_SUBGROUP e73a048d-bf27-4f12-9731-8b2076e8891f	Die Einstellungen in dieser Untergruppe steuern Batteriealarmauslöserpunkte und -aktionen.
GUID_SLEEP_SUBGROUP 238C9FA8-0AAD-41ED-83F4-97BE242C8F20	Einstellungen in dieser Untergruppe steuern die Einstellungen für den Ruhezustand des Systems.
GUID_PCIEXPRESS_SETTINGS_SUBGROUP 501a4d13-42af-4429-9fd1-a8218c268e20	Einstellungen in dieser Untergruppe steuern PCI Express-Einstellungen.

[in, optional] PowerSettingGuid

Der Bezeichner der verwendeten Energieeinstellung.

[out, optional] Buffer

Ein Zeiger auf einen Puffer, der die Beschreibung empfängt. Wenn dieser Parameter NULL ist, empfängt der BufferSize-Parameter die erforderliche Puffergröße. Die zurückgegebenen Zeichenfolgen sind alle breit (Unicode)-Zeichenfolgen.

[in, out] BufferSize

Ein Zeiger auf eine Variable, die die Größe des Puffers enthält, auf den der Buffer-Parameter verweist.

Wenn der Buffer-ParameterNULL ist, gibt die Funktion ERROR_SUCCESS zurück, und die Variable empfängt die erforderliche Puffergröße.

Wenn die angegebene Puffergröße nicht groß genug ist, um die angeforderten Daten aufzunehmen, gibt die Funktion ERROR_MORE_DATA zurück, und die Variable empfängt die erforderliche Puffergröße.

Rückgabewert

Gibt ERROR_SUCCESS (null) zurück, wenn der Aufruf erfolgreich war, und einen Wert ungleich null, wenn der Aufruf fehlgeschlagen ist. Wenn die vom BufferSize-Parameter angegebene Puffergröße zu klein ist, gibt die Funktion ERROR_SUCCESS zurück, und der DWORD-Wert , auf den der BufferSize-Parameter verweist, wird mit der erforderlichen Puffergröße ausgefüllt.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	powrprof.h
Bibliothek	PowrProf.lib
DLL	PowrProf.dll

Weitere Informationen

Energieverwaltungsfunktionen

Freigeben über