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

Статья
08/07/2023

Подпрограмма HidP_UnsetUsages устанавливает в отчете HID использование указанной кнопки управления 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

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

[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	Подпрограмма не обнаружила использование ни в одном отчете указанного типа.

Требования

Требование	Значение
Минимальная версия клиента	Доступно в Windows 2000 и более поздних версиях Windows.
Целевая платформа	Универсальное
Верхняя часть	hidpi.h (включая Hidpi.h)
Библиотека	Hidparse.lib
IRQL	<=DISPATCH_LEVEL