HidP_SetUsageValueArray function (hidpi.h)

Article
10/21/2021

The HidP_SetUsageValueArray routine sets a HID control usage value array in a specified HID report.

Syntax

NTSTATUS HidP_SetUsageValueArray(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in]      USAGE                Usage,
  [in]      PCHAR                UsageValue,
  [in]      USHORT               UsageValueByteLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [in, out] PCHAR                Report,
  [in]      ULONG                ReportLength
);

Parameters

[in] ReportType

Specifies a HIDP_REPORT_TYPE enumerator value that indicates the type of HID report located at Report.

[in] UsagePage

Specifies the usage page of a usage.

[in] LinkCollection

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.

[in] Usage

Specifies the usage.

[in] UsageValue

Pointer to a caller-allocated buffer that contains the data associated with the usage value array.

[in] UsageValueByteLength

Specifies the length, in bytes, of the UsageValue buffer.

[in] PreparsedData

Pointer to a top-level's preparsed data.

[in, out] Report

Pointer to a HID report.

[in] ReportLength

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.

Return value

HidP_SetUsageValueArray returns one of the following status values:

Return code	Description
HIDP_STATUS_SUCCESS	The routine successfully set the usage value.
HIDP_STATUS_INVALID_REPORT_LENGTH	The report length is not valid.
HIDP_STATUS_INVALID_REPORT_TYPE	The specified report type is not valid.
HIDP_STATUS_BUFFER_TOO_SMALL	The size, in bytes, of the UsageValue buffer is too small.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	The usage does not exist in the specified report, but it does exist in a different report of the specified type.
HIDP_STATUS_NOT_VALUE_ARRAY	The specified usage is not a usage value array.
HIDP_STATUS_INVALID_PREPARSED_DATA	The preparsed data is not valid.
HIDP_STATUS_REPORT_DOES_NOT_EXIST	There are no reports of the specified type.
HIDP_STATUS_NOT_IMPLEMENTED	The report size of data fields specified for the usage value array is not a multiple of eight bits.
HIDP_STATUS_USAGE_NOT_FOUND	The usage does not exist in any report of the specified report type.

Remarks

The required size, in bytes, of the UsageValue buffer is determined by multiplying together the BitSize and ReportCount members of the usage value array's HIDP_VALUE_CAPS structure, and rounding the result up to the nearest byte.

HidP_SetUsageValueArray only supports usage value arrays where each data field of the array is a multiple of eight bits.

The caller must set the UsageValue buffer exactly as it should occur in the report.

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