Método IWDFUsbTargetPipe::RetrievePipePolicy (wudfusb.h)

  • Artículo

[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 RetrievePipePolicy recupera una directiva de canalización de WinUsb.

Sintaxis

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

Parámetros

[in] PolicyType

El tipo de directiva de canalización de WinUsb que solicita el controlador UMDF.

[in, out] ValueLength

Puntero a una variable que, en la entrada, contiene el tamaño, en bytes, del búfer que RetrievePipePolicy proporciona para Value. En la salida, este parámetro contiene el tamaño que RetrievePipePolicy requiere para Value.

[out] Value

Puntero que recibe el búfer que contiene la directiva de canalización de WinUsb.

Valor devuelto

RetrievePipePolicy devuelve uno de los valores siguientes:

Código devuelto Descripción
S_OK

RetrievePipePolicy recuperó correctamente la directiva de canalización de WinUsb.
E_OUTOFMEMORY

RetrievePipePolicy 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 de WinUsb.

Comentarios

La directiva de canalización controla el comportamiento de la canalización USB (por ejemplo, tiempos de espera, control de paquetes cortos, etc.).

Para obtener más información sobre los tipos de directiva válidos que un controlador UMDF puede pasar para el parámetro PolicyType y los valores que devuelve el marco, vea la función WinUsb_GetPipePolicy .

Para obtener información sobre el comportamiento de las directivas de canalización, vea Funciones de WinUSB para la modificación de la directiva de canalización.

El método RetrievePipePolicy genera una solicitud UMDF y envía sincrónicamente la solicitud al destino de E/S.

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

IWDFUsbTargetPipe

IWDFUsbTargetPipe::SetPipePolicy

WinUsb_GetPipePolicy