HidP_GetButtonsEx macro (hidpi.h)

Article
02/22/2024

The HidP_GetButtonsEx macro is a mnemonic alias for the HidP_GetUsagesEx function.

Syntax

#define HidP_GetButtonsEx(Rty, LCo, BLi, ULe, Ppd, Rep, RLe) \
         HidP_GetUsagesEx(Rty, LCo, BLi, ULe, Ppd, Rep, RLe)

Parameters

[in] Rty

Specifies a HIDP_REPORT_TYPE enumerator value that identifies the report type.

[in] LCo

Specifies the link collection of the button usages. If LCo is nonzero, the routine only returns information about the buttons that this link collection contains; otherwise, if LCo is zero, the routine returns information about all the buttons in the top-level collection associated with Ppd.

[in, out] BLi

Pointer to a caller-allocated buffer that routine uses to return the usage and usage page identifiers for each button that is set to ON (1).

[in, out] ULe

Specifies, on input, the length, in array elements, of the BLi buffer. Specifies, on output, the number usages that are currently set to ON in the specified report.

[in] Ppd

Pointer to a top-level collection's pre-parsed data.

[in] Rep

Pointer to a report that contains button data.

[in] RLe

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

Return value

None

Remarks

See HidP_GetUsagesEx for return value details.

Requirements

Requirement	Value
Minimum supported client	Available in Windows 2000 and later versions of Windows.
Target Platform	Universal
Header	hidpi.h (include hidpi.h)