HidP_GetButtons macro (hidpi.h)

The HidP_GetButtons macro is a mnemonic alias for the HidP_GetUsages function.

Syntax

#define HidP_GetButtons(Rty, UPa, LCo, ULi, ULe, Ppd, Rep, RLe) \
        HidP_GetUsages(Rty, UPa, LCo, ULi, ULe, Ppd, Rep, RLe)

Parameters

[in] Rty

Specifies a HIDP_REPORT_TYPE enumerator value that identifies the report type.

[in] UPa

Specifies the usage page of the button usages. The routine only returns information about buttons on this usage page.

[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.

[out] ULi

Pointer to a caller-allocated buffer that the routine uses to return the usages of all buttons that are set to ON and belong to the usage page specified by UPa.

[in, out] ULe

Specifies, on input, the length, in array elements, of the ULi buffer. Specifies, on output, the number of buttons that are set to ON on the specified usage page.

[in] Ppd

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

[out] Rep

Pointer to a report.

[in] RLe

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

Return value

None

Remarks

See HidP_GetUsages for return value details.

Requirements

See also

• HidP_GetUsages