WdfUsbTargetPipeAbortSynchronously 関数 (wdfusb.h)

[KMDF と UMDF に適用]

WdfUsbTargetPipeAbortSynchronously メソッドは中止要求をビルドし、指定された USB パイプに同期的に送信します。

構文

NTSTATUS WdfUsbTargetPipeAbortSynchronously(
  [in]           WDFUSBPIPE                Pipe,
  [in, optional] WDFREQUEST                Request,
  [in, optional] PWDF_REQUEST_SEND_OPTIONS RequestOptions
);

パラメーター

[in] Pipe

WdfUsbInterfaceGetConfiguredPipe呼び出すことによって取得されたフレームワーク パイプ オブジェクトへのハンドル。

[in, optional] Request

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

[in, optional] RequestOptions

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

戻り値

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

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

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

備考

WdfUsbTargetPipeAbortSynchronously メソッドを使用して、USB 中止要求を同期的に送信します。 このような要求を非同期に送信するには、WdfUsbTargetPipeFormatRequestForAbortを使用し、その後に WdfRequestSendを します。

USB 中止要求により、ドライバーの I/O ターゲットは、パイプに送信されたすべての I/O 要求を取り消します。 ドライバーが WdfUsbTargetPipeAbortSynchronously呼び出すと、フレームワークは I/O ターゲットに URB_FUNCTION_ABORT_PIPE 要求を送信します。 USB パイプ ("パイプの中止" とも呼ばれます) での操作の取り消しの詳細については、USB 仕様を参照してください。

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

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

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

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

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

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

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

例

次のコード例では、USB デバイスのインターフェイス用に構成されているすべてのパイプに中止要求を送信します。

UCHAR  i;
ULONG  count;
NTSTATUS  status;
PDEVICE_CONTEXT  pDevContext;

pDevContext = GetDeviceContext(Device);

count = WdfUsbInterfaceGetNumConfiguredPipes(
                                             pDevContext->UsbInterface
                                             );

for (i = 0; i < count; i++) {
    WDFUSBPIPE pipe;

    pipe = WdfUsbInterfaceGetConfiguredPipe(
                                            pDevContext->UsbInterface,
                                            i,
                                            NULL
                                            );
    status = WdfUsbTargetPipeAbortSynchronously(
                                                pipe,
                                                WDF_NO_HANDLE,
                                                NULL
                                                );
    if (!NT_SUCCESS(status)) {
        break;
    }
}

必要条件

関連項目

WdfRequestCancelSentRequest

WdfUsbTargetPipeResetSynchronously を する