Partager via

HidP_UnsetButtons (Compact 2013)

  • Article

3/26/2014

This macro is a mnemonic alias for the HidP_UnsetUsages function.

Syntax

#define HidP_UnsetButtons(Rty, Up, Lco, ULi, ULe, Ppd, Rep, Rle) \
        HidP_UnsetUsages(Rty, Up, Lco, ULi, ULe, Ppd, Rep, Rle)

Parameters

  • Rty
    [in] HIDP_REPORT_TYPE enumerator value that indicates the type of report located at Rep.
  • Up
    [in] Usage page of the usages specified by UsageList.
  • Lco
    [in] Link collection that contains the usages. If LinkCollection is nonzero, the function only sets the usages, if they exist, in this link collection. If LinkCollection is zero, the function sets the first usage for each usage it finds in the top-level collection associated with PreparsedData.
  • ULi
    [in] Pointer to the array of usages to set to Off.

  • ULe
    [in, out] On input, the number of usages in UsageList.

    The following table shows the possible values on output.

    Value

    Description

    Input value is unchanged.

    ReportType, PreparsedData, Report, or ReportLength is not valid.

    Input value is unchanged.

    All usages are successfully set to Off.

    Index of the usage in UsageList that caused the error.

    A usage cannot be set to Off.
  • Ppd
    [in] Pointer to the preparsed data of the top-level collection associated with the report located at Rep.
  • Rep
    [in, out] On input, an initialized report. On output, a pointer to a report.
  • Rle
    [in] 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

The following table shows the possible return values.

Value

Description

HIDP_STATUS_SUCCESS

Usages in UsageList are successfully set to Off.

HIDP_STATUS_INVALID_PREPARSED_DATA

Preparsed data specified by PreparsedData is not valid.

HIDP_STATUS_INVALID_REPORT_LENGTH

Report length is not valid.

HIDP_STATUS_INVALID_REPORT_TYPE

Report type is not valid.

HIDP_STATUS_REPORT_DOES_NOT_EXIST

Collection does not contain a report of the specified type.

HIDP_STATUS_BUTTON_NOT_PRESSED

Usage is already set to Off.

HIDP_STATUS_INCOMPATIBLE_REPORT_ID

Report contains a collection with buttons in the specified usage page, but there are no such usages in the report.

HIDP_STATUS_USAGE_NOT_FOUND

Report contains a requested usage that is not in any report supported by the top-level collection.

Remarks

The terms button and usage are used synonymously.

Requirements

Header

hidpi.h

See Also

Reference

HID Parser Macros
HIDP_CAPS
HidP_GetCaps
HIDP_REPORT_TYPE
HidP_SetButtons
HidP_SetData
HidP_SetUsages
HidP_UnsetUsages