EnumPwrSchemes 関数 (powrprof.h)

  • [アーティクル]

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

すべての電源スキームを列挙します。 列挙された電源スキームごとに、関数は電源スキームに関する情報を含むコールバック関数を呼び出します。

構文

BOOLEAN EnumPwrSchemes(
  [in] PWRSCHEMESENUMPROC lpfn,
  [in] LPARAM             lParam
);

パラメーター

[in] lpfn

列挙された電源スキームごとに呼び出されるコールバック関数へのポインター。 詳細については、「解説」を参照してください。

[in] lParam

コールバック関数に渡されるユーザー定義値。

戻り値

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

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

解説

列挙された電源スキームごとに、コールバック関数は次のパラメーターを使用して呼び出されます。


typedef BOOLEAN (CALLBACK* PWRSCHEMESENUMPROC)(
  UINT uiIndex,      // power scheme index
  DWORD dwName,      // size of the sName string, in bytes
  LPWSTR sName,      // name of the power scheme
  DWORD dwDesc,      // size of the sDesc string, in bytes
  LPWSTR sDesc,      // description string
  PPOWER_POLICY pp,  // receives the power policy
  LPARAM lParam      // user-defined value
);

sName パラメーターと sDesc パラメーターは、null で終わる Unicode 文字列です。 pp パラメーターは、電源ポリシー スキームを含むPOWER_POLICY構造体へのポインターです。 すべての電源スキームが列挙されるまで続行するには、コールバック関数が TRUE を返す必要があります。 列挙を停止するには、コールバック関数が FALSE を返す必要があります。

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

要件

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

こちらもご覧ください

POWER_POLICY

Power Management Functions

電源スキーム