Метод IWDFUsbInterface::RetrieveUsbPipeObject (wudfusb.h)

  • Статья

[Предупреждение: UMDF 2 является последней версией UMDF и заменяет UMDF 1. Все новые драйверы UMDF должны быть написаны с помощью UMDF 2. Новые функции не добавляются в UMDF 1, а поддержка UMDF 1 в более новых версиях Windows 10 ограничена. Универсальные драйверы Windows должны использовать UMDF 2. Дополнительные сведения см. в разделе начало работы с помощью UMDF.]

Метод RetrieveUsbPipeObject извлекает объект USB-канала для указанного индекса канала.

Синтаксис

HRESULT RetrieveUsbPipeObject(
  [in]  UCHAR             PipeIndex,
  [out] IWDFUsbTargetPipe **ppPipe
);

Параметры

[in] PipeIndex

Индекс извлекаемого объекта USB-канала.

[out] ppPipe

Указатель на переменную, получающую указатель на интерфейс IWDFUsbTargetPipe для объекта USB-канала, индекс которого задается с помощью PipeIndex.

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

RetrieveUsbPipeObject возвращает одно из следующих значений:

Код возврата Описание
S_OK

RetrieveUsbPipeObject успешно извлек объект USB-канала.
E_OUTOFMEMORY

В RetrieveUsbPipeObject обнаружен сбой выделения.
Код ошибки, определенный в Winerror.h
 Это значение соответствует коду ошибки, возвращенной API WinUsb.

Комментарии

Драйвер UMDF может вызывать методы интерфейса IWDFUsbTargetPipe , который извлекает метод RetrieveUsbPipeObject для получения типа канала и других сведений.

Примеры

Пример кода использования методаRetrieveUsbPipeObject см. в разделе IWDFUsbInterface::GetNumEndPoints.

Требования

Требование Значение
Дата окончания поддержки Недоступно в UMDF 2.0 и более поздних версиях.
Целевая платформа Персональный компьютер
Минимальная версия UMDF 1.5
Верхняя часть wudfusb.h (включая Wudfusb.h)
DLL WUDFx.dll

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

IWDFUsbInterface

IWDFUsbTargetPipe