функция HidP_UnsetUsages (hidpi.h)

Статья
02/07/2025

В отчете HID HidP_UnsetUsages задана кнопка управления HID OFF (ноль).

Синтаксис

NTSTATUS HidP_UnsetUsages(
  [in]           HIDP_REPORT_TYPE     ReportType,
  [in]           USAGE                UsagePage,
  [in, optional] USHORT               LinkCollection,
  [in, out]      PUSAGE               UsageList,
  [in, out]      PULONG               UsageLength,
  [in]           PHIDP_PREPARSED_DATA PreparsedData,
  [in]           PCHAR                Report,
  [in]           ULONG                ReportLength
);

Параметры

[in] ReportType

Указывает значение перечислителя HIDP_REPORT_TYPE, указывающее тип отчета, расположенного в отчета.

[in] UsagePage

Указывает страницу использования использования, указанной UsageList.

[in, optional] LinkCollection

Указывает коллекцию ссылок , содержащую сведения об использовании. Если LinkCollection ненулевое, подпрограмма задает только использование, если они существуют, в этой коллекции ссылок. Если linkCollection равно нулю, подпрограмма устанавливает первое использование для каждого использования, который он находит в коллекции верхнего уровня, связанной с PreparsedData.

[in, out] UsageList

Указатель на массив использования, чтобы задать значение OFF.

[in, out] UsageLength

Указывает количество операций использования в UsageList. Дополнительные сведения о выходном значении см. в разделе "Примечания".

[in] PreparsedData

Указатель на предварительно подготовленные данные коллекции верхнего уровня, связанной с отчетом, расположенным на отчете.

[in] Report

Указатель на отчет.

[in] ReportLength

Задает размер отчета в байтах, расположенный в отчетаотчета, который должен быть равен длине отчета для указанного типа отчета, который HidP_GetCaps возвращается в HIDP_CAPS структуре коллекции.

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

HidP_UnsetUsages возвращает HIDP_STATUS_SUCCESS, если он успешно устанавливает значение OFF для всех использования в UsageList.

HidP_UnsetUsages возвращает одно из следующих значений состояния, если один из входных параметров недопустим:

Возвращаемый код	Описание
HIDP_STATUS_INVALID_PREPARSED_DATA	Предварительно подготовленные данные, указанные PreparsedData, недопустимы.
HIDP_STATUS_INVALID_REPORT_LENGTH	Длина отчета недопустима.
HIDP_STATUS_INVALID_REPORT_TYPE	Недопустимый тип отчета.
HIDP_STATUS_REPORT_DOES_NOT_EXIST	Коллекция не содержит отчет указанного типа.

HidP_UnsetUsages возвращает одно из следующих значений состояния, если не удалось установить значение OFF одно из использования в UsageList:

Возвращаемый код	Описание
HIDP_STATUS_BUTTON_NOT_PRESSED	Для использования уже задано значение OFF.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Использование не содержится в указанном отчете, но содержится в другом отчете указанного типа.
HIDP_STATUS_USAGE_NOT_FOUND	Подпрограмма не обнаружила использования в любом отчете указанного типа.

Замечания

HidP_UnsetUsages задает UsageLength следующим образом:

Дополнительные сведения см. в коллекциях HID.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Доступно в Windows 2000 и более поздних версиях Windows.
целевая платформа	Всеобщий
заголовка	hidpi.h (include Hidpi.h)
библиотеки	Hidparse.lib
IRQL	<=DISPATCH_LEVEL

См. также

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