HidP_GetScaledUsageValue function (hidpi.h)

Article
10/21/2021

The HidP_GetScaledUsageValue routine returns the signed and scaled result of a HID control value extracted from a HID report.

Syntax

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
);

Parameters

[in] ReportType

Specifies a HIDP_REPORT_TYPE enumerator value that identifies the type of HID report that contains the HID usage value.

[in] UsagePage

Specifies the usage page of the value to extract.

[in] LinkCollection

Specifies the link collection identifier of the value to extract. A LinkCollection value of zero identifies the top-level collection.

[in] Usage

Specifies the usage of the value to extract.

[out] UsageValue

Pointer to the buffer in which the routine returns the signed and scaled value.

[in] PreparsedData

Pointer to the preparsed data of the top-level collection that generated the report located at Report.

[in] Report

Pointer to the report that contains the usage.

[in] ReportLength

Specifies the length, in bytes, of the report located at Report.

Return value

HidP_GetScaledUsageValue returns one of the following status values:

Return code	Description
HIDP_STATUS_SUCCESS	The routine successfully returned the value.
HIDP_STATUS_INVALID_REPORT_TYPE	The specified report type is not valid.
HIDP_STATUS_INVALID_REPORT_LENGTH	The specified report length is not valid
HIDP_STATUS_BAD_LOG_PHY_VALUES	The collection returned an illegal logical or physical value. To extract the value returned by the collection, call HidP_GetUsageValue.
HIDP_STATUS_NULL	The current state of the scaled value from the collection is less than the logical minimum or is greater than the logical maximum, and the scaled value has a NULL state.
HIDP_STATUS_VALUE_OUT_OF_RANGE	The current state of the scaled value data from the collection is less than the logical minimum or is greater than the logical maximum.
HIDP_STATUS_USAGE_NOT_FOUND	The specified usage, usage page, or link collection cannot be found in any report supported by the specified top-level collection.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	The specified value is not contained in the specified report, but is contained in another report supported by the specified top-level collection.

Remarks

The caller-allocated buffers supplied at PreparsedData, UsageValue, and Report must be allocated from nonpaged pool.

User-mode applications and kernel-mode drivers must use HidP_GetUsageValueArray to extract data for a usage value array.

If the routine returns status HIDP_STATUS_BAD_LOG_PHY_VALUES, an application or driver can call HidP_GetUsageValue to extract the raw usage data.

For more information, see HID Collections.

Requirements

Requirement	Value
Minimum supported client	Available in Windows 2000 and later versions of Windows.
Target Platform	Universal
Header	hidpi.h (include Hidpi.h)
Library	Hidparse.lib
IRQL	<= DISPATCH_LEVEL