функция WinUsb_GetPowerPolicy (winusb.h)

Статья
08/27/2023

Функция WinUsb_GetPowerPolicy извлекает политику питания для устройства. Это синхронная операция.

Синтаксис

BOOL WinUsb_GetPowerPolicy(
  [in]      WINUSB_INTERFACE_HANDLE InterfaceHandle,
  [in]      ULONG                   PolicyType,
  [in, out] PULONG                  ValueLength,
  [out]     PVOID                   Value
);

Параметры

[in] InterfaceHandle

Непрозрачный дескриптор первого интерфейса на устройстве, возвращаемый WinUsb_Initialize.

[in] PolicyType

Значение типа , указывающее параметр политики управления питанием, который требуется извлечь в поле Значение. В следующей таблице описаны символьные константы, определенные в Winusbio.h.

Тип политики	Описание
AUTO_SUSPEND (0x81)	Если вызывающий объект задает политику питания AUTO_SUSPEND, WinUsb_GetPowerPolicy возвращает значение параметра политики автоматической приостановки в параметре Value . Если значение равноTRUE (то есть ненулевое), стек USB приостанавливает работу устройства, если не ожидается передача данных или единственные ожидающие передачи являются передачами IN в прерывании или массовой конечной точке. Значение реестра DefaultIdleState определяет значение по умолчанию параметра политики автоматической приостановки. Параметр Value должен указывать на переменную UCHAR.
SUSPEND_DELAY (0x83)	Если вызывающий объект задает политику управления питанием SUSPEND_DELAY, WinUsb_GetPowerPolicy возвращает значение параметра политики приостановки задержки в поле Value. Параметр политики приостановки задержки указывает минимальное время (в миллисекундах), в течение которого драйвер WinUSB должен ждать после любой передачи, прежде чем он сможет приостановить устройство. Значение должно указывать на переменную ULONG.

Тип политики

Описание

AUTO_SUSPEND

(0x81)

Если вызывающий объект задает политику питания AUTO_SUSPEND, WinUsb_GetPowerPolicy возвращает значение параметра политики автоматической приостановки в параметре Value .

Если значение равноTRUE (то есть ненулевое), стек USB приостанавливает работу устройства, если не ожидается передача данных или единственные ожидающие передачи являются передачами IN в прерывании или массовой конечной точке.

Значение реестра DefaultIdleState определяет значение по умолчанию параметра политики автоматической приостановки.

Параметр Value должен указывать на переменную UCHAR.

SUSPEND_DELAY

(0x83)

Если вызывающий объект задает политику управления питанием SUSPEND_DELAY, WinUsb_GetPowerPolicy возвращает значение параметра политики приостановки задержки в поле Value.

Параметр политики приостановки задержки указывает минимальное время (в миллисекундах), в течение которого драйвер WinUSB должен ждать после любой передачи, прежде чем он сможет приостановить устройство.

Значение должно указывать на переменную ULONG.

[in, out] ValueLength

Указатель на размер буфера , значение . В выходных данных ValueLength получает размер данных, скопированных в буфер значений .

[out] Value

Буфер, получающий указанный параметр политики управления питанием. Дополнительные сведения см. в разделе PolicyType.

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

WinUsb_GetPowerPolicy возвращает значение TRUE , если операция выполнена успешно. В противном случае эта подпрограмма возвращает значение FALSE, и вызывающий объект может получить зарегистрированную ошибку, вызвав Метод GetLastError.

GetLastError может вернуть следующий код ошибки.

Код возврата	Описание
ERROR_INVALID_HANDLE	Вызывающий объект передал значение NULL в параметре InterfaceHandle .

Требования

Требование	Значение
Целевая платформа	Универсальное
Верхняя часть	winusb.h (включая Winusb.h)
Библиотека	Winusb.lib
DLL	Winusb.dll

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

WinUSB

Функции WinUSB

Управление питанием WinUSB

WinUsb_Initialize

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