次の方法で共有


IWDFUsbTargetDevice::RetrievePowerPolicy メソッド (wudfusb.h)

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

RetrievePowerPolicy メソッドは、WinUsb 電源ポリシーを取得します。

構文

HRESULT RetrievePowerPolicy(
  [in]      ULONG PolicyType,
  [in, out] ULONG *ValueLength,
  [out]     PVOID Value
);

パラメーター

[in] PolicyType

UMDF ドライバーが要求する WinUsb 電源ポリシーの種類。

[in, out] ValueLength

入力時に、Valueで提供される RetrievePowerPolicy バッファーのサイズをバイト単位で格納する変数へのポインター。 出力時に、このパラメーターには、Valueに必要な RetrievePowerPolicy サイズが含まれます。

[out] Value

WinUsb 電源ポリシーを含むバッファーを受け取るポインター。

戻り値

RetrievePowerPolicy は、次のいずれかの値を返します。

リターン コード 形容
S_OK

RetrievePowerPolicy WinUsb 電源ポリシーが正常に取得されました。

E_OUTOFMEMORY

RetrievePowerPolicy 割り当てエラーが発生しました。

Winerror.h で定義されているエラー コード
この値は、WinUsb API から返されたエラー コードに対応します。

備考

電源ポリシーは、デバイスの WinUsb が実行する電源管理を制御します。

UMDF ドライバーが PolicyType パラメーターとフレームワークから返される値に渡すことができる有効なポリシーの種類については、WinUsb_GetPowerPolicy 関数を参照してください。

WinUSB の電源動作の詳細については、WinUSB 電源管理 を参照してください。

RetrievePowerPolicy メソッドは UMDF 要求を生成し、I/O ターゲットに同期的に要求を送信します。

必要条件

要件 価値
サポート終了 UMDF 2.0 以降では使用できません。
ターゲット プラットフォーム デスクトップ
UMDF の最小バージョン する 1.5
ヘッダー wudfusb.h (Wudfusb.h を含む)
DLL WUDFx.dll

関連項目

IWDFUsbTargetDevice

IWDFUsbTargetDevice::SetPowerPolicy

WinUsb_GetPowerPolicy