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


Метод 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 для value. В выходных данных этот параметр содержит размер, необходимый RetrievePipePolicy для значения.

[out] Value

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

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

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

Возвращаемый код Описание
S_OK

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

E_OUTOFMEMORY

ПолучениеPipePolicy произошло сбой выделения.

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

Замечания

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

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

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

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

Требования

Требование Ценность
завершение поддержки Недоступно в UMDF 2.0 и более поздних версиях.
целевая платформа Настольный
минимальная версия UMDF 1.5
заголовка wudfusb.h (include Wudfusb.h)
DLL WUDFx.dll

См. также

IWDFUsbTargetPipe

IWDFUsbTargetPipe::SetPipePolicy

WinUsb_GetPipePolicy