Skip to content

Latest commit

 

History

History
212 lines (159 loc) · 5.66 KB

nf-hidpi-hidp_getscaledusagevalue.md

File metadata and controls

212 lines (159 loc) · 5.66 KB
Raw
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:hidpi.HidP_GetScaledUsageValue
HidP_GetScaledUsageValue function (hidpi.h)
The HidP_GetScaledUsageValue routine returns the signed and scaled result of a HID control value extracted from a HID report.
hid\hidp_getscaledusagevalue.htm
hid
04/30/2018
HidP_GetScaledUsageValue function
HidP_GetScaledUsageValue, HidP_GetScaledUsageValue routine [Human Input Devices], hid.hidp_getscaledusagevalue, hidfunc_7fa22086-ab66-4c6b-a7de-65adce226b10.xml, hidpi/HidP_GetScaledUsageValue
hidpi.h
Hidpi.h
Universal
Available in Windows 2000 and later versions of Windows.
Hidparse.lib
<= DISPATCH_LEVEL
Windows
HidP_GetScaledUsageValue
hidpi/HidP_GetScaledUsageValue
APIRef
kbSyntax
LibDef
Hidparse.lib
Hidparse.dll
HidP_GetScaledUsageValue

HidP_GetScaledUsageValue function

-description

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

-parameters

-param ReportType [in]

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

-param UsagePage [in]

Specifies the usage page of the value to extract.

-param LinkCollection [in]

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

-param Usage [in]

Specifies the usage of the value to extract.

-param UsageValue [out]

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

-param PreparsedData [in]

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

-param Report [in]

Pointer to the report that contains the usage.

-param ReportLength [in]

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

-returns

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.

-see-also

HidP_GetUsageValue

HidP_GetUsageValueArray

_HIDP_PREPARSED_DATA