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
入力時に、Valueに対して RetrievePipePolicy が提供 バッファーのサイズをバイト単位で格納する変数へのポインター。 出力時に、このパラメーターには、Valueに必要な RetrievePipePolicy サイズが含まれます。
[out] Value
WinUsb パイプ ポリシーを含むバッファーを受け取るポインター。
戻り値
RetrievePipePolicy は、次のいずれかの値を返します。
リターン コード | 形容 |
---|---|
|
RetrievePipePolicy WinUsb パイプ ポリシーが正常に取得されました。 |
|
RetrievePipePolicy 割り当てエラーが発生しました。 |
|
この値は、WinUsb API から返されたエラー コードに対応します。 |
備考
パイプ ポリシーは、USB パイプの動作 (タイムアウト、短いパケットの処理など) を制御します。
UMDF ドライバーが PolicyType パラメーターとフレームワークから返される値に渡すことができる有効なポリシーの種類の詳細については、WinUsb_GetPipePolicy 関数を参照してください。
パイプ ポリシーの動作については、「パイプ ポリシー変更 の WinUSB 関数を参照してください。
RetrievePipePolicy メソッドは UMDF 要求を生成し、I/O ターゲットに同期的に要求を送信します。
必要条件
要件 | 価値 |
---|---|
サポート終了 | UMDF 2.0 以降では使用できません。 |
ターゲット プラットフォーム の | デスクトップ |
UMDF の最小バージョン を する | 1.5 |
ヘッダー | wudfusb.h (Wudfusb.h を含む) |
DLL | WUDFx.dll |
関連項目
IWDFUsbTargetPipe の