WdfUsbTargetDeviceSendUrbSynchronously 関数 (wdfusb.h)

[アーティクル]
08/08/2023

[KMDF にのみ適用]

WdfUsbTargetDeviceSendUrbSynchronously メソッドは、URB によって記述される要求パラメーターを使用して、指定された USB デバイスに USB 要求を同期的に送信します。

構文

NTSTATUS WdfUsbTargetDeviceSendUrbSynchronously(
  [in]           WDFUSBDEVICE              UsbDevice,
  [in, optional] WDFREQUEST                Request,
  [in, optional] PWDF_REQUEST_SEND_OPTIONS RequestOptions,
  [in]           PURB                      Urb
);

パラメーター

[in] UsbDevice

WdfUsbTargetDeviceCreateWithParameters の以前の呼び出しから取得された USB デバイスオブジェクトへのハンドル。

[in, optional] Request

フレームワーク要求オブジェクトへのハンドル。このパラメーターは省略可能であり、 NULL にすることができます。詳細については、「解説」を参照してください。

[in, optional] RequestOptions

要求のオプションを指定する呼び出し元によって割り当てられた WDF_REQUEST_SEND_OPTIONS 構造体へのポインター。このポインターは省略可能であり、 NULL にすることができます。詳細については、「解説」を参照してください。

[in] Urb

呼び出し元で初期化された URB 構造体へのポインター。

ドライバーが以前に WdfUsbTargetDeviceCreateWithParameters を呼び出して UsbDevice を作成する場合、ドライバーは WdfUsbTargetDeviceCreateUrb または WdfUsbTargetDeviceCreateIsochUrb を使用してこの URB を作成する必要があります。

戻り値

操作が成功した場合、WdfUsbTargetDeviceSendUrbSynchronously は I/O ターゲットの完了状態値を返します。それ以外の場合、このメソッドは次のいずれかの値を返すことができます。

リターンコード	説明
STATUS_INVALID_PARAMETER	無効なパラメーターが検出されました。
STATUS_INVALID_DEVICE_REQUEST	呼び出し元の IRQL が無効です。
STATUS_INSUFFICIENT_RESOURCES	メモリが不足していました。
STATUS_IO_TIMEOUT	ドライバーがタイムアウト値を指定し、割り当てられた時間内に要求が完了しませんでした。

このメソッドは、他の NTSTATUS 値を返す場合もあります。

ドライバーが無効なオブジェクトハンドルを提供すると、バグチェックが発生します。

注釈

USB コントロール転送要求を同期的に送信するには、 WdfUsbTargetDeviceSendUrbSynchronously メソッドを使用します。このような要求を非同期的に送信するには、 WdfUsbTargetDeviceFormatRequestForUrb を使用し、その後に WdfRequestSend を使用します。

WdfUsbTargetDeviceSendUrbSynchronously メソッドは、要求が完了するまで、ドライバーが RequestOptions パラメーターのWDF_REQUEST_SEND_OPTIONS構造体にタイムアウト値を提供しない限り、またはエラーが検出されない限り、戻りません。

ドライバーが I/O キューで受信した I/O 要求を転送することも、新しい要求を作成して送信することもできます。

ドライバーが I/O キューで受信した I/O 要求を転送するには、 WdfUsbTargetDeviceSendUrbSynchronously メソッドの Request パラメーターに対して、受信した要求のハンドルを指定します。

新しい要求を作成して送信するには、Request パラメーターに NULL 要求ハンドルを指定するか、新しい要求オブジェクトを作成してそのハンドルを指定します。

NULL 要求ハンドルを指定すると、フレームワークは内部要求オブジェクトを使用します。この手法は簡単に使用できますが、ドライバーは要求を取り消すことができません。
WdfRequestCreate を呼び出して 1 つ以上の要求オブジェクトを作成する場合は、WdfRequestReuse を呼び出してこれらの要求オブジェクトを再利用できます。この手法を使用すると、ドライバーの EvtDriverDeviceAdd コールバック関数を使用して、デバイスの要求オブジェクトを事前に割り当てることができます。さらに、別のドライバースレッドは WdfRequestCancelSentRequest を呼び出して、必要に応じて要求を取り消すことができます。

ドライバーは、NULL 以外の RequestOptions パラメーターを指定できます。ドライバーが NULL 以外の要求パラメーターと NULL要求パラメーターのどちらを提供しているか。たとえば、 RequestOptions パラメーターを使用してタイムアウト値を指定できます。

I/O 要求の完了後に状態情報を取得する方法については、「完了情報の取得」を参照してください。

WdfUsbTargetDeviceSendUrbSynchronously メソッドと USB I/O ターゲットの詳細については、「USB I/O ターゲット」を参照してください。

例

次のコード例では、URB 構造体を初期化し、 WdfUsbTargetDeviceSendUrbSynchronously を呼び出します。

URB Urb;
NTSTATUS status;

Urb.UrbHeader.Function =  URB_FUNCTION_GET_CONFIGURATION;
Urb.UrbHeader.Length = sizeof(struct _URB_CONTROL_GET_CONFIGURATION_REQUEST);
Urb.UrbControlGetConfigurationRequest.TransferBufferLength = 1 ; // Must be 1
Urb.UrbControlGetConfigurationRequest.TransferBufferMDL = NULL;
Urb.UrbControlGetConfigurationRequest.TransferBuffer = outBuffer;
Urb.UrbControlGetConfigurationRequest.UrbLink = NULL;

status = WdfUsbTargetDeviceSendUrbSynchronously(
                                                UsbDevice,
                                                NULL,
                                                NULL,
                                                &Urb
                                                );

要件

要件	値
対象プラットフォーム	ユニバーサル
最小 KMDF バージョン	1.0
Header	wdfusb.h (Wdfusb.h を含む)
Library	Wdf01000.sys (「Framework ライブラリのバージョン管理」を参照)。
IRQL	PASSIVE_LEVEL
DDI コンプライアンス規則	DriverCreate(kmdf)、 KmdfIrql(kmdf)、 KmdfIrql2(kmdf)、KmdfIrqlExplicit(kmdf)、 SyncReqSend(kmdf)、 UsbKmdfIrql(kmdf)、 UsbKmdfIrql2(kmdf)、UsbKmdfIrqlExplicit(kmdf)