SetActivePwrScheme 関数 (powrprof.h)

  • [アーティクル]

[SetActivePwrScheme は、[要件] セクションで指定したオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 Windows Vista 以降用に作成されたアプリケーションでは、代わりに PowerSetActiveScheme を使用する必要があります。

アクティブな電源スキームを設定します。

構文

BOOLEAN SetActivePwrScheme(
  [in]           UINT                 uiID,
  [in, optional] PGLOBAL_POWER_POLICY pGlobalPowerPolicy,
  [in, optional] PPOWER_POLICY        pPowerPolicy
);

パラメーター

[in] uiID

アクティブ化する電源スキームのインデックス。

[in, optional] pGlobalPowerPolicy

オプションの GLOBAL_POWER_POLICY 構造体へのポインター。これにより、アクティブになったときに電源スキームとマージされるグローバル電源ポリシー設定が提供されます。

[in, optional] pPowerPolicy

オプションの POWER_POLICY 構造体へのポインター。アクティブになったときに電源スキームとマージされる電源ポリシー設定を提供します。

戻り値

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

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

解説

この関数を使用して、システム構成を長期的に変更します。 アプリケーションがタスクを実行している間にシステムの実行を一時的に維持するには、 SetThreadExecutionState 関数を使用します。

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

lpGlobalPowerPolicy が NULL の場合、関数は WriteGlobalPwrPolicy によって設定された現在のグローバル電源ポリシー設定を使用します。 それ以外の場合は、指定した構造体の設定によって、現在のグローバル電源ポリシー設定が置き換えられます。

lpPowerPolicy が NULL の場合、関数は電源スキームの現在の電源ポリシー設定を使用します。 それ以外の場合は、指定した構造体の設定によって、現在の電源ポリシー設定が置き換えられます。

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

要件

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

こちらもご覧ください

GLOBAL_POWER_POLICY

GetActivePwrScheme

POWER_POLICY

Power Management Functions

電源スキーム