PowerReadPossibleDescription 関数 (powrprof.h)
電源設定値の選択肢の 1 つの説明を取得します。
構文
DWORD PowerReadPossibleDescription(
[in, optional] HKEY RootPowerKey,
[in, optional] const GUID *SubGroupOfPowerSettingsGuid,
[in, optional] const GUID *PowerSettingGuid,
[in] ULONG PossibleSettingIndex,
[out, optional] PUCHAR Buffer,
[in, out] LPDWORD BufferSize
);
パラメーター
[in, optional] RootPowerKey
このパラメーターは将来使用するために予約されており、 NULL に設定する必要があります。
[in, optional] SubGroupOfPowerSettingsGuid
電源設定のサブグループ。 このパラメーターには、WinNT.h で定義されている次のいずれかの値を指定できます。 NO_SUBGROUP_GUIDを使用して、既定の電源スキームを参照します。
[in, optional] PowerSettingGuid
使用されている電源設定の識別子。
[in] PossibleSettingIndex
使用可能な設定の 0 から始まるインデックス。
[out, optional] Buffer
説明を受け取るバッファーへのポインター。 このパラメーターが NULL の場合、 BufferSize パラメーターは必要なバッファー サイズを受け取ります。 返される文字列はすべてワイド (Unicode) 文字列です。
[in, out] BufferSize
Buffer パラメーターが指すバッファーのサイズを含む変数へのポインター。
Buffer パラメーターが NULL の場合、関数は ERROR_SUCCESSを返し、変数は必要なバッファー サイズを受け取ります。
指定されたバッファー サイズが要求されたデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA を返し、変数は必要なバッファー サイズを受け取ります。
戻り値
呼 び出しが成功した 場合はERROR_SUCCESS (ゼロ) を返し、呼び出しが失敗した場合は 0 以外の値を返します。 BufferSize パラメーターで指定されたバッファー サイズが小さすぎる場合は、
ERROR_MORE_DATAが返され、BufferSize パラメーターによって指される DWORD に必要なバッファー サイズが入力されます。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | powrprof.h |
| Library | PowrProf.lib |
| [DLL] | PowrProf.dll |