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

Статья
02/07/2025

[ предупреждение: 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	ПолучениеUsbPipeObject произошло сбой выделения.
Код ошибки, определенный в Winerror.h	Это значение соответствует коду ошибки, возвращенной API WinUsb.

Замечания

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

Примеры

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

Требования

Требование	Ценность
завершение поддержки	Недоступно в UMDF 2.0 и более поздних версиях.
целевая платформа	Настольный
минимальная версия UMDF	1.5
заголовка	wudfusb.h (include Wudfusb.h)
DLL	WUDFx.dll

См. также

IWDFUsbInterface

IWDFUsbTargetPipe

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