PowerReadDescription 関数 (powrprof.h)

指定した電源設定、サブグループ、またはスキームの説明を取得します。 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を使用して、既定の電源スキームを参照します。

[in, optional] PowerSettingGuid

使用されている電源設定の識別子。

[out, optional] Buffer

説明を受け取るバッファーへのポインター。 このパラメーターが NULL の場合、 BufferSize パラメーターは必要なバッファー サイズを受け取ります。 返される文字列はすべてワイド (Unicode) 文字列です。

[in, out] BufferSize

Buffer パラメーターによって指されるバッファーのサイズを含む変数へのポインター。

Buffer パラメーターが NULL の場合、関数は ERROR_SUCCESSを返し、変数は必要なバッファー サイズを受け取ります。

指定したバッファー サイズが、要求されたデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA を返し、変数は必要なバッファー サイズを受け取ります。

戻り値

呼び出 しが 成功した場合はERROR_SUCCESS (0) を返し、呼び出しが失敗した場合は 0 以外の値を返します。 BufferSize パラメーターで指定されたバッファー サイズが小さすぎる場合、関数は ERROR_SUCCESSを返し、BufferSize パラメーターが指す DWORD には必要なバッファー サイズが入力されます。

要件

こちらもご覧ください

Power Management Functions