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

Статья
02/26/2024

Подпрограмма HidP_SetScaledUsageValue преобразует подписанное и масштабированное физическое число в логическое значение использования HID и задает значение использования в указанном отчете HID.

Синтаксис

NTSTATUS HidP_SetScaledUsageValue(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in]      USAGE                Usage,
  [in]      LONG                 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_SetScaledUsageValue возвращает одно из следующих значений состояния:

Код возврата	Описание
HIDP_STATUS_SUCCESS	Подпрограмма успешно задает значение использования.
HIDP_STATUS_BAD_LOG_PHY_VALUES	Использование имеет недопустимый логический или физический диапазон, который предотвращает масштабирование.
HIDP_STATUS_VALUE_OUT_OF_RANGE	Указанное физическое значение выходит за пределы диапазона, а использование не имеет значения NULL.
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_STATUS_NULL	Указанное физическое значение выходит за пределы диапазона, использование имеет значение NULL, а подпрограмма задает значение NULL.

Если подпрограмма возвращает HIDP_STATUS_INCOMPATIBLE_REPORT_ID, указанный отчет содержит сведения об использовании. Однако приложение в пользовательском режиме или драйвер режима ядра могут задать использование в отчете с нулевой инициализацией. См. раздел Инициализация отчетов HID.

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

Требования

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