Skip to content

Latest commit

 

History

History
94 lines (65 loc) · 3.19 KB

nf-hidpi-hidp_usagelistdifference.md

File metadata and controls

94 lines (65 loc) · 3.19 KB
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:hidpi.HidP_UsageListDifference
HidP_UsageListDifference function (hidpi.h)
The HidP_UsageListDifference routine returns the differences between two arrays of HID usages.
hid\hidp_usagelistdifference.htm
hid
04/30/2018
HidP_UsageListDifference function
HidP_UsageListDifference, HidP_UsageListDifference routine [Human Input Devices], hid.hidp_usagelistdifference, hidfunc_91cbddd2-90f6-4784-9f1d-6d9bf8be35d3.xml, hidpi/HidP_UsageListDifference
hidpi.h
Hidpi.h
Universal
Available in Windows 2000 and later versions of Windows.
Hidparse.lib
PASSIVE_LEVEL
Windows
HidP_UsageListDifference
hidpi/HidP_UsageListDifference
APIRef
kbSyntax
LibDef
Hidparse.lib
Hidparse.dll
HidP_UsageListDifference

HidP_UsageListDifference function

-description

The HidP_UsageListDifference routine returns the differences between two arrays of HID usages.

-parameters

-param PreviousUsageList [in]

Pointer to a list of usages that the routine compares with the list of usages in CurrentUsageList.

-param CurrentUsageList [in]

Pointer to a list of usages that the routine compares with the list of usages in PreviousUsageList.

-param BreakUsageList [out]

Pointer to a caller-allocated buffer that, on return, contains a list of the usages that are in PreviousUsageList, but not in CurrentUsageList.

-param MakeUsageList [out]

Pointer to a caller-allocated buffer that, on return, contains a list of the usages that are in CurrentUsageList, but not in PreviousUsageList.

-param UsageListLength [in]

Specifies the length, in array elements, of the buffers provided at CurrentUsageList and PreviousUsageList.

-returns

HidP_UsageListDifference returns HIDP_STATUS_SUCCESS.

-remarks

A user-mode application or kernel-mode driver can use this routine to compare two usage lists, for example, to determine the change in button state between two usage lists returned by two HidP_GetButtons calls.

If the input usage lists have different lengths, an application or driver should set UsageListLength to the length of the larger list.

The routine interprets a zero usage in an input usage list as a delimiter that ends the list. Any usages after a zero in a list are not processed. Unused usages in an output list are set to zero.

For more information, see HID Collections.

-see-also

HidP_UsageAndPageListDifference