Share via

функция 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
 Указанное значение не содержится в указанном отчете, но содержится в другом отчете, поддерживаемом указанной коллекцией верхнего уровня.

Комментарии

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

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

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

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

Требования

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

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

HidP_GetUsageValue

HidP_GetUsageValueArray

_HIDP_PREPARSED_DATA