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

Artigo
02/07/2025

[Aviso: UMDF 2 é a versão mais recente do UMDF e substitui o UMDF 1. Todos os novos drivers UMDF devem ser gravados usando UMDF 2. Nenhum recurso novo está sendo adicionado ao UMDF 1 e há suporte limitado para UMDF 1 em versões mais recentes do Windows 10. Os drivers universais do Windows devem usar o UMDF 2. Para obter mais informações, consulte Introdução aoda UMDF .]

O método RetrieveUsbPipeObject recupera um objeto de pipe USB para o índice de pipe especificado.

Sintaxe

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

Parâmetros

[in] PipeIndex

O índice do objeto de pipe USB a ser recuperado.

[out] ppPipe

Um ponteiro para uma variável que recebe um ponteiro para a interface IWDFUsbTargetPipe para o objeto de pipe USB cujo índice é especificado por PipeIndex.

Valor de retorno

RetrieveUsbPipeObject retorna um dos seguintes valores:

Código de retorno	Descrição
S_OK	RetrieveUsbPipeObject recuperou com êxito o objeto de pipe USB.
E_OUTOFMEMORY	RetrieveUsbPipeObject encontrou uma falha de alocação.
Um código de erro definido em Winerror.h	Esse valor corresponde ao código de erro retornado pela API do WinUsb.

Observações

Um driver UMDF pode chamar os métodos da interface IWDFUsbTargetPipe que o método RetrieveUsbPipeObject recupera para obter o tipo de pipe e outras informações.

Exemplos

Para obter um exemplo de código de como usar o método RetrieveUsbPipeObject, consulte IWDFUsbInterface::GetNumEndPoints.

Requisitos

Requisito	Valor
fim do suporte	Indisponível no UMDF 2.0 e posterior.
da Plataforma de Destino	Área de trabalho
versão mínima do UMDF	1.5
cabeçalho	wudfusb.h (inclua Wudfusb.h)
de DLL	WUDFx.dll

Consulte também

IWDFUsbInterface

IWDFUsbTargetPipe

Compartilhar via