Функция HidP_SetUsages (hidpi.h)

Статья
02/26/2024

Подпрограмма HidP_SetUsages задает указанные управляющие кнопки HID ON (1) в отчете HID.

Синтаксис

NTSTATUS HidP_SetUsages(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      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] LinkCollection

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

[in, out] UsageList

Указатель на массив использования.

[in, out] UsageLength

Указывает на входные данные количество использования в Списке использования. Сведения о выходном значении см. в разделе Примечания.

[in] PreparsedData

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

[in] Report

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

[in] ReportLength

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

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

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

Код возврата	Описание
HIDP_STATUS_SUCCESS	Подпрограмма успешно задала значение использования.
HIDP_STATUS_BUFFER_TOO_SMALL	Невозможно задать использование в массиве кнопок, так как массив уже полностью задан.
HIDP_STATUS_INVALID_REPORT_LENGTH	Недопустимая длина отчета.
HIDP_STATUS_INVALID_REPORT_TYPE	Указанный тип отчета недопустим.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Использование не существует в указанном отчете, но существует в другом отчете указанного типа.
HIDP_STATUS_INVALID_PREPARSED_DATA	Подготовленные данные являются недопустимыми.
HIDP_STATUS_USAGE_NOT_FOUND	Использование не существует ни в одном отчете указанного типа отчета.

Если HidP_SetUsages не удается задать использование в UsageList, подпрограмма присваивает UsageLength индексу использования, которое не удалось задать, и возвращает значение состояния, указывающее на ошибку.

Дополнительные сведения см. в разделе Коллекции HID.

Требования

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