HidP_SetUsages - NtDoc

Native API online documentation, based on the System Informer (formerly Process Hacker) phnt headers 
// hidpi.h

NTSTATUS HidP_SetUsages(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in, out] PUSAGE               UsageList,
  [in, out] PULONG               UsageLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [in]      PCHAR                Report,
  [in]      ULONG                ReportLength
);
View the official Windows Driver Kit DDI reference

NtDoc

No description available.

Edit description on GitHub

Windows Driver Kit DDI reference (nf-hidpi-hidp_setusages)

HidP_SetUsages function

Description

The HidP_SetUsages routine sets specified HID control buttons ON (1) in a HID report.

Parameters

ReportType [in]

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

UsagePage [in]

Specifies the usage page for the usages specified by UsageList.

LinkCollection [in]

Specifies the link collection that contains the usages. If LinkCollection is nonzero, the routine only sets the usages, if they exist, in this link collection. If LinkCollection is zero, the routine sets the first usage for each specified usage in the top-level collection associated with PreparsedData.

UsageList [in, out]

Pointer to the array of usages.

UsageLength [in, out]

Specifies, on input, the number of usages in UsageList. See the Remarks section for information about the output value.

PreparsedData [in]

Pointer to the preparsed data of the top-level collection associated with the report located at Report.

Report [in]

Pointer to a report.

ReportLength [in]

Specifies the size, in bytes, of the 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_SetUsages returns one of the following status values:

Return code Description
HIDP_STATUS_SUCCESS The routine successfully set the usage value.
HIDP_STATUS_BUFFER_TOO_SMALL A usage in a button array cannot be set because the array is already fully set.
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_INCOMPATIBLE_REPORT_ID A usage does not exist in the specified report, but it does exist in a different report of the specified type.
HIDP_STATUS_INVALID_PREPARSED_DATA The preparsed data is not valid.
HIDP_STATUS_USAGE_NOT_FOUND A usage does not exist in any report of the specified report type.

Remarks

If HidP_SetUsages cannot set a usage in UsageList, the routine sets UsageLength to the index of the usage that could not be set, and returns a status value that indicates the error.

For more information, see HID Collections.

See also

HidP_GetButtons

HidP_GetUsages

HidP_SetButtons

HidP_UnsetButtons

HidP_UnsetUsages

_HIDP_PREPARSED_DATA

View the official Windows Driver Kit DDI reference

Edit description on GitHub