> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# IGameInputDevice::GetKeyboardInfo

> Récupère les propriétés de clavier du périphérique, comme son type de clavier, sa disposition et son nombre de touches.

Récupère les propriétés de clavier du périphérique, comme son type de clavier, sa disposition et son nombre de touches.

## Syntaxe

```cpp theme={null}
bool GetKeyboardInfo(
    GameInputKeyboardInfo* info
);
```

### Paramètres

*info*   \_Out\_\
Type : [GameInputKeyboardInfo](https://docs.xbox.com/fr-CA/reference/input/gameinput/structs/gameinputkeyboardinfo.md)\*

Pointeur vers une structure `GameInputKeyboardInfo` qui reçoit les propriétés de clavier du périphérique. Si le périphérique ne prend pas en charge l'entrée de clavier, chaque membre de la structure est mis à zéro.

### Valeur de retour

Type : bool

`true` si le périphérique prend en charge l'entrée de clavier et que *info* a été rempli; sinon, `false`.

## Remarques

La méthode `GetKeyboardInfo` copie les propriétés de clavier du périphérique dans la structure fournie par l'appelant. Un périphérique prend en charge l'entrée de clavier lorsque la valeur retournée par [GetSupportedInput](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedinput.md) inclut `GameInputKindKeyboard`. Si le périphérique ne prend pas en charge l'entrée de clavier, `GetKeyboardInfo` initialise *info* à zéro et retourne `false`.

La plupart des propriétés de clavier sont fixes pendant toute la durée de vie du périphérique. L'exception est le membre `layout`, que GameInput met à jour sur place lorsque la disposition de clavier active change (par exemple, lorsque l'utilisateur change de langue de saisie). Lorsque la disposition change, GameInput déclenche l'événement `GameInputDeviceEventKeyboardLayoutUpdated` de type [GameInputDeviceEvent](https://learn.microsoft.com/en-us/gaming/gdk/docs/reference/input/gameinput/enums/gameinputdeviceevent) vers les rappels de périphérique inscrits avec [IGameInput::RegisterDeviceCallback](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinput/methods/igameinput_registerdevicecallback.md). Appelez de nouveau `GetKeyboardInfo` à partir de ce rappel pour lire la nouvelle disposition.

L'exemple suivant montre comment interroger les propriétés de clavier d'un périphérique.

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

Dans GameInput v3 et les versions antérieures, ces informations étaient disponibles dans le membre `keyboardInfo` de la structure [GameInputDeviceInfo](https://docs.xbox.com/fr-CA/reference/input/gameinput/deprecated/structs/gameinputdeviceinfo.md) retournée par [IGameInputDevice::GetDeviceInfo](https://docs.xbox.com/fr-CA/reference/input/gameinput/deprecated/interfaces/igameinputdevice/methods/igameinputdevice_getdeviceinfo.md).

## Configuration requise

**En-tête :** GameInput.h

**Bibliothèque :** gameinput.lib

**Plateformes prises en charge :** Windows, consoles de la famille XBOX One et consoles XBOX Series

## Voir aussi

[Vue d'ensemble de GameInput](https://docs.xbox.com/fr-CA/build/core-features/common/input/overviews/input-overview.md)\
[GameInputKeyboardInfo](https://docs.xbox.com/fr-CA/reference/input/gameinput/structs/gameinputkeyboardinfo.md)\
[GetSupportedInput](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedinput.md)\
[GameInputKind](https://docs.xbox.com/fr-CA/reference/input/gameinput/enums/gameinputkind.md)\
[IGameInput::RegisterDeviceCallback](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinput/methods/igameinput_registerdevicecallback.md)\
[GameInputDeviceEvent](https://learn.microsoft.com/en-us/gaming/gdk/docs/reference/input/gameinput/enums/gameinputdeviceevent)\
[IGameInputReading::GetKeyState](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getkeystate.md)\
[IGameInputDevice](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/igameinputdevice.md)

## Historique des versions

| Version | Modifications |
| - | - |
| **v4** | Introduit. |


## Related topics

- [GameInputKeyboardInfo](https://docs.xbox.com/fr-CA/reference/input/gameinput/structs/gameinputkeyboardinfo.md)
- [IGameInput::RegisterKeyboardLayoutCallback (déprécié)](https://docs.xbox.com/fr-CA/reference/input/gameinput/deprecated/interfaces/igameinput/methods/igameinput_registerkeyboardlayoutcallback.md)
- [IGameInput::RegisterDeviceCallback](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinput/methods/igameinput_registerdevicecallback.md)
- [IGameInputDevice::GetInputReportInfo](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getinputreportinfo.md)
- [IGameInputDevice::GetGamepadInfo](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getgamepadinfo.md)