Metodo IWDFUsbTargetPipe::RetrievePipePolicy (wudfusb.h)

  • Articolo

[Avviso: UMDF 2 è la versione più recente di UMDF e sostituisce UMDF 1. Tutti i nuovi driver UMDF devono essere scritti usando UMDF 2. Non vengono aggiunte nuove funzionalità a UMDF 1 ed è disponibile un supporto limitato per UMDF 1 nelle versioni più recenti di Windows 10. I driver di Windows universali devono usare UMDF 2. Per altre info, vedi Introduzione con UMDF.]

Il metodo RetrievePipePolicy recupera un criterio di pipe WinUsb.

Sintassi

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

Parametri

[in] PolicyType

Tipo di criterio pipe WinUsb richiesto dal driver UMDF.

[in, out] ValueLength

Puntatore a una variabile che, all'input, contiene le dimensioni, in byte, del buffer fornito da RetrievePipePolicy per Value. Nell'output questo parametro contiene le dimensioni richieste da RetrievePipePolicy per Value.

[out] Value

Puntatore che riceve il buffer che contiene i criteri di pipe WinUsb.

Valore restituito

RetrievePipePolicy restituisce uno dei valori seguenti:

Codice restituito Descrizione
S_OK

RetrievePipePolicy ha recuperato correttamente i criteri della pipe WinUsb.
E_OUTOFMEMORY

RetrievePipePolicy ha rilevato un errore di allocazione.
Codice di errore definito in Winerror.h
 Questo valore corrisponde al codice di errore restituito dall'API WinUsb.

Commenti

I criteri pipe controllano il comportamento della pipe USB ,ad esempio timeout, gestione di pacchetti brevi e così via.

Per altre informazioni sui tipi di criteri validi che un driver UMDF può passare per il parametro PolicyType e i valori restituiti dal framework, vedere la funzione WinUsb_GetPipePolicy .

Per informazioni sul comportamento dei criteri di pipe, vedere Funzioni WinUSB per la modifica dei criteri di pipe.

Il metodo RetrievePipePolicy genera una richiesta UMDF e invia in modo sincrono la richiesta alla destinazione di I/O.

Requisiti

Requisito Valore
Fine del supporto Non disponibile in UMDF 2.0 e versioni successive.
Piattaforma di destinazione Desktop
Versione UMDF minima 1.5
Intestazione wudfusb.h (include Wudfusb.h)
DLL WUDFx.dll

Vedi anche

IWDFUsbTargetPipe

IWDFUsbTargetPipe::SetPipePolicy

WinUsb_GetPipePolicy