Поделиться через

Метод IWDFUsbTargetPipe::RetrievePipePolicy (wudfusb.h)

  • Статья

[Предупреждение: UMDF 2 является последней версией UMDF и заменяет UMDF 1. Все новые драйверы UMDF должны быть написаны с помощью UMDF 2. В UMDF 1 новые функции не добавляются, а поддержка UMDF 1 в более новых версиях Windows 10 ограничена. Универсальные драйверы Windows должны использовать UMDF 2. Дополнительные сведения см. в разделе начало работы с UMDF.]

Метод RetrievePipePolicy извлекает политику канала WinUsb.

Синтаксис

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

Параметры

[in] PolicyType

Тип политики канала WinUsb, запрашиваемой драйвером UMDF.

[in, out] ValueLength

Указатель на переменную, которая во входных данных содержит размер буфера, который RetrievePipePolicy предоставляет для Значения ( в байтах). В выходных данных этот параметр содержит размер, требуемый RetrievePipePolicy для значения.

[out] Value

Указатель, получающий буфер, содержащий политику канала WinUsb.

Возвращаемое значение

RetrievePipePolicy возвращает одно из следующих значений:

Код возврата Описание
S_OK

RetrievePipePolicy успешно извлекла политику канала WinUsb.
E_OUTOFMEMORY

В RetrievePipePolicy произошла ошибка выделения.
Код ошибки, определенный в Winerror.h
 Это значение соответствует коду ошибки, возвращенной API WinUsb.

Комментарии

Политика канала управляет поведением USB-канала (например, истечением времени ожидания, обработкой коротких пакетов и т. д.).

Дополнительные сведения о допустимых типах политик, которые драйвер UMDF может передать для параметра PolicyType и значений, возвращаемых платформой, см . в WinUsb_GetPipePolicy функции.

Сведения о поведении политик канала см. в разделе Функции WinUSB для изменения политики канала.

Метод RetrievePipePolicy создает запрос UMDF и синхронно отправляет запрос в целевой объект ввода-вывода.

Требования

Требование Значение
Дата окончания поддержки Недоступно в UMDF 2.0 и более поздних версиях.
Целевая платформа Персональный компьютер
Минимальная версия UMDF 1.5
Верхняя часть wudfusb.h (включая Wudfusb.h)
DLL WUDFx.dll

См. также раздел

IWDFUsbTargetPipe

IWDFUsbTargetPipe::SetPipePolicy

WinUsb_GetPipePolicy