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

Статья
08/07/2023

Подпрограмма HidP_GetUsageValue извлекает данные, связанные со значением элемента управления HID, которое соответствует критериям выбора в отчете HID.

Синтаксис

NTSTATUS HidP_GetUsageValue(
  [in]  HIDP_REPORT_TYPE     ReportType,
  [in]  USAGE                UsagePage,
  [in]  USHORT               LinkCollection,
  [in]  USAGE                Usage,
  [out] PULONG               UsageValue,
  [in]  PHIDP_PREPARSED_DATA PreparsedData,
  [in]  PCHAR                Report,
  [in]  ULONG                ReportLength
);

Параметры

[in] ReportType

Задает значение перечислителя HIDP_REPORT_TYPE , определяющее тип отчета.

[in] UsagePage

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

[in] LinkCollection

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

[in] Usage

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

[out] UsageValue

Указатель на буфер, в котором подпрограмма возвращает данные значения.

[in] PreparsedData

Указатель на подготовленные данные коллекции верхнего уровня.

[in] Report

Указатель на отчет, содержащий значения.

[in] ReportLength

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

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

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

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

HidP_GetUsageValue значение не подписывается и не масштабируется. Чтобы извлечь подписанное значение, используйте HidP_GetScaledUsageValue. Чтобы вручную назначить бит знака, положение бита знака можно определить на основе сведений в HIDP_VALUE_CAPS структуре значения.

HidP_GetUsageValue предназначен для извлечения значения использования для использования, число отчетов которого равно 1. Если указанное использование содержит число отчетов больше 1, оно является частью массива значений использования. HidP_GetUsageValue возвращает только первый элемент данных в массиве значений использования. Чтобы извлечь все элементы данных в массиве значений использования, используйте HidP_GetUsageValueArray.

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

Требования

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