IGameInputDevice::GetKeyboardInfo

Retrieves the keyboard properties of the device, such as its keyboard kind, layout, and key count.

Syntax

bool GetKeyboardInfo(
    GameInputKeyboardInfo* info
);

Parameters

info _Out_
Type: GameInputKeyboardInfo* Pointer to a GameInputKeyboardInfo structure that receives the keyboard properties of the device. If the device doesn’t support keyboard input, every member of the structure is set to zero.

Return value

Type: bool true if the device supports keyboard input and info was filled in; otherwise, false.

Remarks

The GetKeyboardInfo method copies the keyboard properties of the device into the caller-provided structure. A device supports keyboard input when the value returned by GetSupportedInput includes GameInputKindKeyboard. If the device doesn’t support keyboard input, GetKeyboardInfo zero-initializes info and returns false. Most keyboard properties are fixed for the lifetime of the device. The exception is the layout member, which GameInput updates in place when the active keyboard layout changes (for example, when the user switches input languages). When the layout changes, GameInput raises the GameInputDeviceEventKeyboardLayoutUpdated GameInputDeviceEvent to device callbacks registered with IGameInput::RegisterDeviceCallback. Call GetKeyboardInfo again from that callback to read the new layout. The following example shows how to query the keyboard properties of a device.

GameInputKeyboardInfo info;
if (device->GetKeyboardInfo(&info))
{
    uint32_t keyboardLayout = info.layout;
    uint32_t keyCount = info.keyCount;
    // ...
}

In GameInput v3 and earlier, this information was available from the keyboardInfo 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