IGameInputDevice::GetVendorId

Gets the vendor ID of the input device.

Syntax

uint16_t GetVendorId();

Parameters

This method has no parameters.

Return value

Type: uint16_t The vendor ID that identifies the manufacturer of the input device, or 0 if the device doesn’t report a vendor ID.

Remarks

The vendor ID, together with the product ID returned by IGameInputDevice::GetProductId, identifies a specific device model. For USB and Bluetooth devices, these are typically the same vendor and product IDs that the device reports to the operating system. Use IGameInputDevice::GetRevisionNumber to distinguish between hardware revisions of the same product. The vendor ID doesn’t change for the lifetime of the device object. The following example checks whether a device matches a specific vendor and product ID.

bool IsDeviceModel(
    IGameInputDevice* device,
    uint16_t vendorId,
    uint16_t productId) noexcept
{
    return device->GetVendorId() == vendorId &&
           device->GetProductId() == productId;
}

In GameInput v3 and earlier, this information was available from the vendorId member of the GameInputDeviceInfo structure returned by IGameInputDevice::GetDeviceInfo.

Requirements

Header: GameInput.h Library: gameinput.lib Supported platforms: Windows, XBOX One family consoles and XBOX Series consoles

Version History

Version	Changes
v4	Introduced.

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Additional pages

Reference

Syntax

Parameters

Return value

Remarks

Requirements

See also

Version History

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

​Version History

Syntax

Parameters

Return value

Remarks

Requirements

See also

Version History