| 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_SetScaledUsageValue |
HidP_SetScaledUsageValue function (hidpi.h) |
The HidP_SetScaledUsageValue routine converts a signed and scaled physical number to a HID usage's logical value, and sets the usage value in a specified HID report. |
hid\hidp_setscaledusagevalue.htm |
hid |
04/30/2018 |
|
HidP_SetScaledUsageValue, HidP_SetScaledUsageValue routine [Human Input Devices], hid.hidp_setscaledusagevalue, hidfunc_0fcd2d78-aae7-4d56-a930-9bf0e4a417bf.xml, hidpi/HidP_SetScaledUsageValue |
hidpi.h |
Hidpi.h |
Universal |
Available in Windows 2000 and later versions of Windows. |
Hidparse.lib |
<= DISPATCH_LEVEL |
Windows |
|
|
|
|
|
The HidP_SetScaledUsageValue routine converts a signed and scaled physical number to a HID usage's logical value, and sets the usage value in a specified HID report.
Specifies a HIDP_REPORT_TYPE enumerator value that indicates the type of HID report located at Report.
Specifies the usage page of a usage.
Specifies the link collection that contains the usage. If LinkCollection is nonzero, the routine only sets the usage, if one exists, in this link collection. If LinkCollection is zero, the routine sets the first usage it finds in the top-level collection associated with PreparsedData.
Specifies the usage.
Specifies the signed and scaled physical number, which the routine converts to the usage's logical value.
Pointer to a top-level's preparsed data.
Pointer to a HID report.
Specifies the size, in bytes, of the HID report located at Report, which must be equal to the report length for the specified report type that HidP_GetCaps returns in a collection's HIDP_CAPS structure.
HidP_SetScaledUsageValue returns one of the following status values:
| Return code | Description |
|---|---|
|
The routine successfully set the usage value. |
|
The usage has an illegal logical or physical range that prevents scaling. |
|
The specified physical value is out-of-range and the usage does not have null value. |
|
The report length is not valid. |
|
The specified report type is not valid. |
|
The usage does not exist in the specified report, but it does exist in a different report of the specified type. |
|
The preparsed data is not valid. |
|
The usage does not exist in any report of the specified report type. |
|
The specified physical value is out-of-range, the usage has a null value, and the routine set the null value. |
HidP_SetScaledUsageValue sets the sign bit.
If the routine returns HIDP_STATUS_INCOMPATIBLE_REPORT_ID, the specified report does contain the usage. However, a user-mode application or kernel-mode driver can set the usage in a zero-initialized report. See Initializing HID Reports.
For more information, see HID Collections.