Método IWDFUsbTargetPipe::RetrievePipePolicy (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 RetrievePipePolicy recupera uma política de pipe winUsb.

Sintaxe

HRESULT RetrievePipePolicy(
  [in]      ULONG PolicyType,
  [in, out] ULONG *ValueLength,
  [out]     PVOID Value
);

Parâmetros

[in] PolicyType

O tipo de política de pipe winUsb que o driver UMDF solicita.

[in, out] ValueLength

Um ponteiro para uma variável que, na entrada, contém o tamanho, em bytes, do buffer que o RetrievePipePolicy fornece para Value. Na saída, esse parâmetro contém o tamanho que RetrievePipePolicy requer para Value.

[out] Value

Um ponteiro que recebe o buffer que contém a política de pipe do WinUsb.

Valor de retorno

RetrievePipePolicy retorna um dos seguintes valores:

Código de retorno	Descrição
S_OK	RetrievePipePolicy recuperou com êxito a política de pipe winUsb.
E_OUTOFMEMORY	RetrievePipePolicy 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

A política de pipe controla o comportamento do pipe USB (por exemplo, tempos limite, manipulação de pacotes curtos e assim por diante).

Para obter mais informações sobre os tipos de política válidos que um driver UMDF pode passar para o parâmetro PolicyType e os valores retornados pela estrutura, consulte a função WinUsb_GetPipePolicy.

Para obter informações sobre o comportamento das políticas de pipe, consulte WinUSB Functions for Pipe Policy Modification.

O método RetrievePipePolicy gera uma solicitação UMDF e envia a solicitação de forma síncrona para o destino de E/S.

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

IWDFUsbTargetPipe

IWDFUsbTargetPipe::SetPipePolicy

WinUsb_GetPipePolicy

Compartilhar via