WDF_IO_QUEUE_PURGED関数 (wdfio.h)

[KMDF と UMDF に適用]

WDF_IO_QUEUE_PURGED関数は、I/O キューの状態がキューがドレインされていることを示す場合に TRUE を返します。

構文

BOOLEAN WDF_IO_QUEUE_PURGED(
  [in] WDF_IO_QUEUE_STATE State
);

パラメーター

[in] State

WdfIoQueueGetState が返すWDF_IO_QUEUE_STATE型指定された値。

戻り値

WDF_IO_QUEUE_PURGED は、指定したキューの状態がキューが消去されたことを示す場合に TRUE を 返します。 それ以外の場合、関数は FALSE を返します。

注釈

キューが空で、新しい I/O 要求を受け入れず、キュー内のすべての要求が取り消された場合、I/O キューは消去されます。

ドライバーは、WdfIoQueueGetState を呼び出した後、WDF_IO_QUEUE_PURGEDを呼び出すことができます。

I/O キューの状態の詳細については、「 WDF_IO_QUEUE_STATE」を参照してください。

例

次のコード例は、指定した I/O キューが消去された場合に TRUE を 返すルーチンです。

BOOLEAN
IsQueuePurged(
    IN WDFQUEUE Queue
    )
{
    WDF_IO_QUEUE_STATE queueStatus;
    queueStatus = WdfIoQueueGetState(
                                     Queue,
                                     NULL,
                                     NULL
                                     );
    return (WDF_IO_QUEUE_PURGED(queueStatus)) ? TRUE : FALSE;
}

要件

要件	値
対象プラットフォーム	ユニバーサル
最小 KMDF バージョン	1.0
Header	wdfio.h (Wdf.h を含む)
Library	なし
IRQL	任意の IRQL。

こちらもご覧ください

WDF_IO_QUEUE_DRAINED

WDF_IO_QUEUE_IDLE

WDF_IO_QUEUE_READY

WDF_IO_QUEUE_STOPPED