Поделиться через

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

  • Статья

Подпрограмма HidP_GetScaledUsageValue возвращает подписанный и масштабируемый результат значения элемента управления HID, извлеченного из отчета HID.

Синтаксис

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

Параметры

[in] ReportType

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

[in] UsagePage

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

[in] LinkCollection

Указывает идентификатор коллекции ссылок для извлечения значения. Значение LinkCollection от нуля определяет коллекцию верхнего уровня.

[in] Usage

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

[out] UsageValue

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

[in] PreparsedData

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

[in] Report

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

[in] ReportLength

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

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

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

Возвращаемый код Описание
HIDP_STATUS_SUCCESS Подпрограмма успешно вернула значение.
HIDP_STATUS_INVALID_REPORT_TYPE Указанный тип отчета недопустим.
HIDP_STATUS_INVALID_REPORT_LENGTH Указанная длина отчета недопустима.
HIDP_STATUS_BAD_LOG_PHY_VALUES Коллекция вернула недопустимое логическое или физическое значение. Чтобы извлечь значение, возвращаемое коллекцией, вызовите HidP_GetUsageValue.
HIDP_STATUS_NULL Текущее состояние масштабируемого значения из коллекции меньше логического минимума или больше логического максимума, а масштабируемое значение имеет состояние NULL.
HIDP_STATUS_VALUE_OUT_OF_RANGE Текущее состояние данных масштабируемого значения из коллекции меньше логического минимума или больше логического максимума.
HIDP_STATUS_USAGE_NOT_FOUND Указанная страница использования, страница использования или коллекция ссылок не найдена в любом отчете, поддерживаемом указанной коллекцией верхнего уровня.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID Указанное значение не содержится в указанном отчете, но содержится в другом отчете, поддерживаемом указанной коллекцией верхнего уровня.

Замечания

Масштабируемые значения относятся к скорректированному выводу необработанных данных HID, которые изменяются на основе определенных параметров, таких как конфиденциальность и диапазон устройства. Эта корректировка позволяет более понятно интерпретировать данные относительно предполагаемого использования устройства.

Дополнительные сведения о интерпретации отчетов HID и важности масштабируемых значений см. в интерпретации отчетов HID.

Выделенные вызывающим буферы, предоставляемые в PreparsedData, UsageValueи отчета должны быть выделены из непагрегированного пула.

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

Если подпрограмма возвращает состояние HIDP_STATUS_BAD_LOG_PHY_VALUES, приложение или драйвер может вызывать HidP_GetUsageValue для извлечения необработанных данных об использовании.

Дополнительные сведения см. в коллекциях HID.

Требования

Требование Ценность
минимальные поддерживаемые клиентские Доступно в Windows 2000 и более поздних версиях Windows.
целевая платформа Всеобщий
заголовка hidpi.h (include Hidpi.h)
библиотеки Hidparse.lib
IRQL <= DISPATCH_LEVEL

См. также