IWDFUsbTargetPipe::RetrievePipePolicy メソッド (wudfusb.h)

  • [アーティクル]

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

RetrievePipePolicy メソッドは、WinUsb パイプ ポリシーを取得します。

構文

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

パラメーター

[in] PolicyType

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

[in, out] ValueLength

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

[out] Value

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

戻り値

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

リターン コード 説明
S_ok

RetrievePipePolicy が WinUsb パイプ ポリシーを正常に取得しました。
E_OUTOFMEMORY

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

注釈

パイプ ポリシーは、USB パイプの動作 (タイムアウト、短いパケットの処理など) を制御します。

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

パイプ ポリシーの動作については、「パイプ ポリシー の変更のための WinUSB 関数」を参照してください。

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

要件

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

こちらもご覧ください

IWDFUsbTargetPipe

IWDFUsbTargetPipe::SetPipePolicy

WinUsb_GetPipePolicy