Функция WdfIoQueueRetrieveRequestByFileObject (wdfio.h)

Статья
08/08/2023

[Применимо к KMDF и UMDF]

Метод WdfIoQueueRetrieveRequestByFileObject извлекает следующий доступный запрос ввода-вывода из указанной очереди ввода-вывода, связанной с указанным объектом файла.

Синтаксис

NTSTATUS WdfIoQueueRetrieveRequestByFileObject(
  [in]  WDFQUEUE      Queue,
  [in]  WDFFILEOBJECT FileObject,
  [out] WDFREQUEST    *OutRequest
);

Параметры

[in] Queue

Дескриптор объекта очереди платформы.

[in] FileObject

Дескриптор объекта файла платформы.

[out] OutRequest

Указатель на расположение, которое получает дескриптор объекта запроса платформы. Если WdfIoQueueRetrieveRequestByFileObject не возвращает STATUS_SUCCESS, он не задает значение расположения.

Возвращаемое значение

WdfIoQueueRetrieveRequestByFileObject возвращает STATUS_SUCCESS, если операция выполнена успешно. В противном случае этот метод может возвращать одно из следующих значений:

Код возврата	Описание
STATUS_INVALID_PARAMETER	Драйвер предоставил недопустимый дескриптор.
STATUS_NO_MORE_ENTRIES	Платформа достигла конца очереди ввода-вывода.
STATUS_INVALID_DEVICE_STATE	Указанная очередь ввода-вывода настраивается для метода параллельной диспетчеризации.
STATUS_WDF_PAUSED	Указанная очередь ввода-вывода управляется питанием , а ее устройство находится в малом энергопотреблении.

Этот метод также может возвращать другие значения NTSTATUS.

Ошибка проверка возникает, если драйвер предоставляет недопустимый дескриптор объекта.

Драйвер, настроив очередь ввода-вывода для ручной или последовательной диспетчеризации, может вызвать WdfIoQueueRetrieveRequestByFileObject. Дополнительные сведения об использовании WdfIoQueueRetrieveRequestByFileObject с ручными или последовательными методами диспетчеризации см. в разделе Методы диспетчеризации для запросов ввода-вывода.

После вызова WdfIoQueueRetrieveRequestByFileObject для получения запроса ввода-вывода драйвер владеет запросом и должен каким-то образом обработать запрос ввода-вывода .

Дополнительные сведения о методе WdfIoQueueRetrieveRequestByFileObject см. в разделе Управление очередями ввода-вывода.

Примеры

В следующем примере кода из указанной очереди ввода-вывода получается дескриптор следующего объекта запроса платформы, связанный с указанным объектом файла платформы.

WDFREQUEST  request;

status = WdfIoQueueRetrieveRequestByFileObject(
                                               queue,
                                               fileObject,
                                               &request
                                               );

Требования

Требование	Значение
Целевая платформа	Универсальное
Минимальная версия KMDF	1,0
Минимальная версия UMDF	2,0
Верхняя часть	wdfio.h (включая Wdf.h)
Библиотека	Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL	<= DISPATCH_LEVEL
Правила соответствия DDI	DoubleCompletion(kmdf), DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

См. также раздел

WdfIoQueueRetrieveFoundRequest

WdfIoQueueRetrieveNextRequest

Поделиться через