Skip to main content

IGameInput::RegisterKeyboardLayoutCallback

Registers a callback function when a keyboard layout is changed.

Syntax

Parameters

device   _In_opt_
Type: IGameInputDevice*
Optionally limits registered callback to trigger a specific device. context   _In_opt_
Type: void*
An object that provides relevant information for the callback function. Typically, it is the calling object. callbackFunc   _In_
Type: GameInputKeyboardLayoutCallback
Title-defined callback function that is called when the keyboard layout is changed. callbackToken   _Result_zeroonfailure_
Type: GameInputCallbackToken*
Token identifying the registered callback function. This token is used to identify the registered function if you need to cancel or unregister the callback function.

Return value

Type: HRESULT Function result.

Remarks

The RegisterKeyboardLayoutCallback method registers a callback function when a keyboard layout is changed. For related information, see the IGameInput::UnregisterCallback and IGameInput::StopCallback methods. For intermediate and advanced use-cases of the GameInput API, see Advanced GameInput topics.

Requirements

The RegisterKeyboardLayoutCallback method registers a callback function when a keyboard layout is changed. For related information, see the IGameInput::UnregisterCallback and IGameInput::StopCallback methods. For intermediate and advanced use-cases of the GameInput API, see Advanced GameInput topics. Header: GameInput.h Overview of GameInput
IGameInput

Version History

Last modified on August 4, 2026