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

Статья
08/07/2023

Подпрограмма HidP_SetUsageValue задает значение элемента управления HID в указанном отчете HID.

Синтаксис

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

Параметры

[in] ReportType

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

[in] UsagePage

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

[in] LinkCollection

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

[in] Usage

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

[in] UsageValue

Задает значение использования.

[in] PreparsedData

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

[in, out] Report

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

[in] ReportLength

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

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

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

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

HidP_SetUsageValue подпрограмма не подписывает значение. Приложение пользовательского режима или драйвер режима ядра должны либо подписать значение в позиции, указанной в структуре HIDP_VALUE_CAPS для этого значения, либо вызвать HidP_SetScaledUsageValue.

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

Требования

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

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

HIDP_VALUE_CAPS

HidP_SetScaledUsageValue

_HIDP_PREPARSED_DATA

Share via