ReadPwrScheme 関数 (powrprof.h)

  • [アーティクル]

[ReadPwrScheme は、[要件] セクションで指定されたオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 「備考」を参照してください。

指定した電源スキームに固有の電源ポリシー設定を取得します。

構文

BOOLEAN ReadPwrScheme(
  [in]  UINT          uiID,
  [out] PPOWER_POLICY pPowerPolicy
);

パラメーター

[in] uiID

読み取る電源スキームのインデックス。

[out] pPowerPolicy

電源ポリシー設定を受け取る POWER_POLICY 構造体へのポインター。

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

指定した電源スキームが存在しない場合、関数は FALSE を返します。

システムで現在使用されている電源ポリシー設定に関する情報を取得するには、 GetActivePwrScheme 関数を呼び出します。 現在の電源ポリシー設定に関する追加情報を取得するには、 CallNtPowerInformation 関数を呼び出します。

Windows Vista 以降では、 PowerEnumerate 関数を使用して、指定したスキームの電源設定を列挙し、電源読み取り関数を使用して個々の設定を取得します。

PowrProf.h の使用方法の詳細については、「 Power Schemes」を参照してください。

要件

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

こちらもご覧ください

GetActivePwrScheme

POWER_POLICY

Power Management Functions

電源スキーム

WritePwrScheme