IGameInput::FindDeviceFromPlatformString (v2)

Retrieves an IGameInputDevice interface based on a matching platform string.

Syntax

HRESULT FindDeviceFromPlatformString(
    LPCWSTR value,
    IGameInputDevice** device
);

Parameters

value   _In_
Type: LPCWSTR

Platform string to match.

device   _COM_Outptr_
Type: IGameInputDevice**

Returned IGameInputDevice interface.

Return value

Type: HRESULT

Function result.

Remarks

After it is obtained, the IGameInputDevice instance is used as a filter in the polling or event-based APIs (to retrieve input), or used directly to access device-specific information and features. If the specified platform string cannot be matched with any known GameInput device objects, this method returns a NULL pointer. The method queries the local state within the calling process and returns quickly, so it is safe to call from time-sensitive contexts.

Requirements

Header: GameInput.h

Library: gameinput.lib

Supported platforms: Windows

See also

Advanced GameInput topics IOverview of GameInput IGameInput