WritePwrScheme 関数 (powrprof.h)

[アーティクル]
08/25/2023

[WritePwrScheme は、Windows Vista の時点では使用できなくなりました。代わりに、 PowerEnumerate 関数を使用して、指定したスキームの電源設定を列挙し、power write 関数を使用して個々の設定を書き込みます。

指定した電源スキームに固有のポリシー設定を書き込みます。

構文

BOOLEAN WritePwrScheme(
  [in]           PUINT         puiID,
  [in]           LPCWSTR       lpszSchemeName,
  [in, optional] LPCWSTR       lpszDescription,
  [in]           PPOWER_POLICY lpScheme
);

パラメーター

[in] puiID

書き込む電源スキームのインデックス。同じインデックスを持つ電源スキームが既に存在する場合は、置き換えられます。それ以外の場合は、新しい電源スキームが作成されます。

[in] lpszSchemeName

電源スキームの名前。

[in, optional] lpszDescription

電源スキームの説明。

[in] lpScheme

書き込む電源ポリシー設定を含む POWER_POLICY 構造体へのポインター。

戻り値

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

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

解説

この変更は、現在のシステム電源ポリシーには影響しません。この変更を現在のシステム電源ポリシーに適用するには、この電源スキームのインデックスを使用して SetActivePwrScheme 関数を呼び出します。

WritePwrScheme を使用して書き込まれた電源ポリシースキームは、システムレジストリハイブに永続的に格納され、Power Options コントロールパネルプログラムや、その後の電源スキーム API の呼び出しで使用できます。システムから電源スキームを完全に削除するには、 DeletePwrScheme 関数を呼び出します。

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

要件

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