Método IWDFUsbInterface::RetrieveUsbPipeObject (wudfusb.h)

[Advertencia: UMDF 2 es la versión más reciente de UMDF y sustituye a UMDF 1. Todos los controladores UMDF nuevos deben escribirse con UMDF 2. No se agregan nuevas características a UMDF 1 y hay compatibilidad limitada con UMDF 1 en versiones más recientes de Windows 10. Los controladores universales de Windows deben usar UMDF 2. Para obtener más información, consulta Introducción con UMDF.

El método RetrieveUsbPipeObject recupera un objeto de canalización USB para el índice de canalización especificado.

Sintaxis

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

Parámetros

[in] PipeIndex

Índice del objeto de canalización USB que se va a recuperar.

[out] ppPipe

Puntero a una variable que recibe un puntero a la interfaz IWDFUsbTargetPipe para el objeto de canalización USB cuyo índice especifica PipeIndex.

Valor devuelto

RetrieveUsbPipeObject devuelve uno de los siguientes valores:

Código devuelto	Descripción
S_OK	RetrieveUsbPipeObject recuperó correctamente el objeto de canalización USB.
E_OUTOFMEMORY	RetrieveUsbPipeObject encontró un error de asignación.
Código de error definido en Winerror.h	Este valor corresponde al código de error que devolvió la API winUsb.

Comentarios

Un controlador UMDF puede llamar a los métodos de la interfaz IWDFUsbTargetPipe que el método RetrieveUsbPipeObject recupera para obtener el tipo de canalización y otra información.

Ejemplos

Para obtener un ejemplo de código sobre cómo usar el métodoRetrieveUsbPipeObject , vea IWDFUsbInterface::GetNumEndPoints.

Requisitos

Requisito	Value
Finalización del soporte técnico	No disponible en UMDF 2.0 y versiones posteriores.
Plataforma de destino	Escritorio
Versión mínima de UMDF	1.5
Encabezado	wudfusb.h (incluya Wudfusb.h)
Archivo DLL	WUDFx.dll

Consulte también

IWDFUsbInterface

IWDFUsbTargetPipe