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 キーの下にある設定の列挙が返されます。
[in] AccessFlags
列挙対象を指定するフラグのセット
[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 |