The HidP_GetScaledUsageValue routine returns the signed and scaled result of a HID control value extracted from a HID report.
NTSTATUS HidP_GetScaledUsageValue( HIDP_REPORT_TYPE ReportType, USAGE UsagePage, USHORT LinkCollection, USAGE Usage, PLONG UsageValue, PHIDP_PREPARSED_DATA PreparsedData, PCHAR Report, ULONG ReportLength );
Specifies a HIDP_REPORT_TYPE enumerator value that identifies the type of HID report that contains the HID usage value.
Specifies the usage page of the value to extract.
Specifies the link collection identifier of the value to extract. A LinkCollection value of zero identifies the top-level collection.
Specifies the usage of the value to extract.
Pointer to the buffer in which the routine returns the signed and scaled value.
Pointer to the report that contains the usage.
Specifies the length, in bytes, of the report located at Report.
HidP_GetScaledUsageValue returns one of the following status values:
||The routine successfully returned the value.|
||The specified report type is not valid.|
||The specified report length is not valid|
||The collection returned an illegal logical or physical value. To extract the value returned by the collection, call HidP_GetUsageValue.|
||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.|
||The current state of the scaled value data from the collection is less than the logical minimum or is greater than the logical maximum.|
||The specified usage, usage page, or link collection cannot be found in any report supported by the specified top-level collection.|
||The specified value is not contained in the specified report, but is contained in another report supported by the specified top-level collection.|
The caller-allocated buffers supplied at PreparsedData, UsageValue, and Report must be allocated from nonpaged pool.
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.
|Minimum supported client||Available in Windows 2000 and later versions of Windows.|
|Header||hidpi.h (include Hidpi.h)|