IWDFIoTargetStateManagement::Stop メソッド (wudfddi.h)

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

Stop メソッドは、キューに登録された要求のローカル I/O ターゲットへの送信を停止します。

構文

HRESULT Stop(
  [in] WDF_IO_TARGET_SENT_IO_ACTION Action
);

パラメーター

[in] Action

I/O ターゲット オブジェクトが停止したときに送信された I/O を処理する方法を識別する、 WDF_IO_TARGET_SENT_IO_ACTION型指定された値。

戻り値

Stop は常にS_OKを返します。

注釈

ドライバーが回復可能なデバイス エラーを検出できる場合は、ドライバーが Stop を呼び出してローカル I/O ターゲットへの要求の送信を一時的に停止し、後で IWDFIoTargetStateManagement::Start を呼び出して要求の送信を再開することができます。

さらに、ドライバーが IWDFUsbTargetPipe2::ConfigureContinuousReader を呼び出して USB パイプの連続リーダーを構成する場合、ドライバーの IPnpCallback::OnD0Exit コールバック関数は Stop を呼び出してリーダーを停止する必要があります。

ドライバーが Stop を呼び出した場合でも、 IWDFIoRequest::Send を呼び出すときに WDF_REQUEST_OPTION_IGNORE_TARGET_STATE フラグを設定することで、ターゲットに要求を送信できます。 ドライバーがこのフラグを設定した場合、ドライバーは、ドライバーが Stop を呼び出した後、USB パイプをリセットする要求 (IWDFUsbTargetPipe::Reset を参照) などの要求をデバイスに送信できます。

ドライバーは IWDFIoTargetStateManagement::Start と Stop を同期的に呼び出す必要があります。 ドライバーは、これらの関数のいずれかを呼び出した後、最初の呼び出しが返される前に、どちらの関数も呼び出してはなりません。

ドライバーは、IWDFIoTargetStateManagement::Start を呼び出さずに Stop を複数回呼び出すことができます。 たとえば、ドライバーで次の操作を行う場合があります。

1. Stop を呼び出し、Action 値 WdfIoTargetLeaveSentIoPending を指定します。
2. ターゲットが I/O 要求の処理を再開する必要があるかどうかを判断します。
3. ターゲットを再開する必要がある場合は、 IWDFIoTargetStateManagement::Start を呼び出します。 それ以外の場合は、Action 値 WdfIoTargetCancelSentIo を指定して Stop を再度呼び出します。

停止の詳細については、「一般的な I/O ターゲットの状態の制御」を参照してください。

I/O ターゲットの詳細については、「 I/O ターゲットの使用」を参照してください。

例

次のコード例は、ドライバーが USB パイプに連続リーダーを使用している場合に、 IPnpCallback::OnD0Exit コールバック関数が Stop を呼び出す方法を示しています。 ( IWDFIoTargetStateManagement インターフェイスを取得する方法については、 IWDFIoTargetStateManagement::Start のコード例を参照してください)。

HRESULT
CMyDevice::OnD0Exit(
    __in IWDFDevice*  pWdfDevice,
    __in WDF_POWER_DEVICE_STATE  previousState
    )
{
    HRESULT hr;
    hr = m_pIoTargetInterruptPipeStateMgmt->Stop(WdfIoTargetCancelSentIo);
    return hr;
}

要件

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

こちらもご覧ください

IWDFIoTargetStateManagement

IWDFRemoteTarget::Stop