Edit

HidP_GetVersion function (hidpi.h)

  • Article

The HidP_GetVersion function is a header-only implementation that returns the HID API version.

Syntax

NTSTATUS HidP_GetVersion(
  [out] ULONG *Version
);

Parameters

[out] Version

The version of the HID API.

Return value

HidP_GetVersion returns STATUS_SUCCESS if the call was successful. Otherwise, it returns an NTSTATUS error code.

Remarks

Call HidP_GetVersion at runtime before using HidP_GetButtonArray or HidP_SetButtonArray. The HidP_GetButtonArray and HidP_SetButtonArray functions are only available on operating systems where HidP_GetVersion returns a value of two or greater. Version two of the API corresponds to Windows 11.

HidP_GetVersion is safe to call on down-level systems because it is a header-only implementation.

Requirements

Requirement Value
Header hidpi.h

See also