PowerReadDescription-Funktion (powrprof.h)

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.

[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

Weitere Informationen

Energieverwaltungsfunktionen