PowerEnumerate 関数 (powrprof.h)

  • [アーティクル]

電源スキームで指定された要素を列挙します。 この関数は通常、 Index パラメーターをインクリメントして、サブキーがすべて列挙されるまで取得するループで呼び出されます。

構文

DWORD PowerEnumerate(
  [in, optional]  HKEY                RootPowerKey,
  [in, optional]  const GUID          *SchemeGuid,
  [in, optional]  const GUID          *SubGroupOfPowerSettingsGuid,
  [in]            POWER_DATA_ACCESSOR AccessFlags,
  [in]            ULONG               Index,
  [out, optional] UCHAR               *Buffer,
  [in, out]       DWORD               *BufferSize
);

パラメーター

[in, optional] RootPowerKey

このパラメーターは将来使用するために予約されており、 NULL に設定する必要があります。

[in, optional] SchemeGuid

電源スキームの識別子。 このパラメーターが NULL の場合は、電源ポリシーの列挙が返されます。

[in, optional] SubGroupOfPowerSettingsGuid

電源設定のサブグループ。 このパラメーターが NULL の場合は、 PolicyGuid キーの下にある設定の列挙が返されます。

値 意味
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] AccessFlags

列挙対象を指定するフラグのセット

値 意味
ACCESS_SCHEME
16
 電源スキームを列挙します。 SchemeGuid パラメーターとサブグループOfPowerSettingsGuid パラメーターは無視されます。
ACCESS_SUBGROUP
17
 SchemeGuid の下のサブグループを列挙します。 サブグループOfPowerSettingsGuid パラメーターは無視されます。
ACCESS_INDIVIDUAL_SETTING
18
 SchemeGuid\サブグループOfPowerSettingsGuid で個々の電源設定を列挙します。 SchemeGuid キーのすぐ下にある電源設定を列挙するには、NO_SUBGROUP_GUID をサブグループOfPowerSettingsGuidパラメーターとして使用します。

[in] Index

列挙されるスキーム、サブグループ、または設定の 0 から始まるインデックス。

[out, optional] Buffer

要素を受け取る変数へのポインター。 このパラメーターが NULL の場合、関数は必要なバッファーのサイズを取得します。

[in, out] BufferSize

入力時に Buffer パラメーターが指すバッファーのサイズを含む変数へのポインター。 Buffer パラメーターが NULL の場合、または BufferSize が十分な大きさでない場合、関数はERROR_MORE_DATAを返し、変数は必要なバッファー サイズを受け取ります。

戻り値

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

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー powrprof.h
Library PowrProf.lib
[DLL] PowrProf.dll

こちらもご覧ください

POWER_DATA_ACCESSOR

Power Management Functions