IWDFDevice2::GetSystemPowerAction メソッド (wudfddi.h)

[警告: UMDF 2 は UMDF の最新バージョンであり、UMDF 1 よりも優先されます。 すべての新しい UMDF ドライバーは、UMDF 2 を使用して記述する必要があります。 UMDF 1 には新機能が追加されておらず、新しいバージョンのWindows 10では UMDF 1 のサポートが制限されています。 ユニバーサル Windows ドライバーでは、UMDF 2 を使用する必要があります。 詳細については、「UMDF を使用したはじめに」を参照してください。

GetSystemPowerAction メソッドは、コンピューターで現在発生しているシステム電源アクション (存在する場合) を返します。

構文

POWER_ACTION GetSystemPowerAction();

戻り値

GetSystemPowerAction は 、POWER_ACTION型指定の列挙子値を返します。 値は、コンピューターに対して現在発生している システム電源アクション を示します。 詳細については、「解説」を参照してください。

注釈

GetSystemPowerAction メソッドを使用すると、ドライバーは、デバイスがアイドル状態 (またはスリープ解除中) であるか、またはコンピューター全体が低電力状態に入っている (または離れている) ために、デバイスの電源切り替えが発生しているかどうかを判断できます。

ドライバーは、デバイスが低電力状態に入ったとき、またはその動作状態に戻るときにフレームワークが呼び出すイベント コールバック関数からのみ GetSystemPowerAction を呼び出す必要があります。

GetSystemPowerAction が返す値は、次の状況によって異なります。

• ドライバーが GetSystemPowerAction を呼び出すときにコンピューターが低電力状態に入っている場合、このメソッドは、コンピューターが低電力状態になった理由を返します。 たとえば、コンピューターが S1、S2、または S3 の低電力状態に入っている場合、メソッドは PowerActionSleep を返します。
• ドライバーが GetSystemPowerAction を呼び出すときに、コンピューターが低電力状態から動作 (S0) 状態に戻っている場合、このメソッドは、コンピューターが低電力状態になった理由を返します。 たとえば、コンピューターが S1、S2、または S3 の低電力状態を残している場合、メソッドは PowerActionSleep を返します。
• ドライバーが GetSystemPowerAction を呼び出すときにコンピューターの電源が切れている場合、メソッドは PowerActionNone を返します。
• ドライバーが GetSystemPowerAction を呼び出したときに、デバイスが低電力アイドル状態に入っているか、動作 (D0) 状態に戻り、システムの残りの部分が動作 (S0) 状態のままである場合、メソッドは PowerActionNone を返します。
• ドライバーが GetSystemPowerAction を呼び出すときにコンピューターとデバイスの両方が動作状態にある場合、メソッドは PowerActionNone を返します。

低電力状態の詳細については、「 A Device Enters a Low-Power State」を参照してください。

例

次のコード例では、 IWDFDevice2 インターフェイスを取得し、 GetSystemPowerAction を呼び出します。

   IWDFDevice2 *pDevice2 = NULL;
    HRESULT hrQI = pDevice->QueryInterface(IID_PPV_ARGS(&pDevice2));
    if (SUCCEEDED(hrQI))
    {
        POWER_ACTION powerAction = pDevice2->GetSystemPowerAction();
    }
...
    SAFE_RELEASE(pDevice2);

要件

要件	値
サポート終了	UMDF 2.0 以降では使用できません。
対象プラットフォーム	デスクトップ
最小 UMDF バージョン	1.9
Header	wudfddi.h (Wudfddi.h を含む)
[DLL]	WUDFx.dll

こちらもご覧ください

IWDFDevice2