> ## 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::GetDisplayName

> Obtient le nom d'affichage convivial du périphérique d'entrée sous forme de chaîne UTF-8.

Obtient le nom d'affichage convivial du périphérique d'entrée sous forme de chaîne UTF-8.

## Syntaxe

```cpp theme={null}
uint32_t GetDisplayName(
    uint32_t bufferByteCount,
    char* buffer
);
```

### Paramètres

*bufferByteCount*   \_In\_\
Type : uint32\_t

La taille, en octets, de la mémoire tampon vers laquelle pointe *buffer*. Transmettez 0 pour demander la taille requise.

*buffer*   \_Out\_writes\_bytes\_opt\_(bufferByteCount)\
Type : char\*

La mémoire tampon qui reçoit le nom d'affichage UTF-8 terminé par un caractère nul. Transmettez `nullptr` pour demander la taille requise.

### Valeur de retour

Type : uint32\_t

La taille, en octets, de la mémoire tampon requise pour contenir le nom d'affichage, y compris le caractère nul de fin.

## Remarques

La méthode écrit le nom d'affichage dans *buffer* uniquement si *buffer* n'est pas `nullptr` et que *bufferByteCount* est supérieur ou égal à la taille requise. Sinon, la mémoire tampon n'est pas modifiée. Pour récupérer le nom d'affichage, appelez d'abord la méthode avec un *bufferByteCount* de 0 et un *buffer* `nullptr` pour obtenir la taille requise, allouez une mémoire tampon de cette taille, puis appelez de nouveau la méthode.

Si le périphérique n'a pas de nom d'affichage, la taille requise est de 1 et la méthode écrit une chaîne vide.

Le nom d'affichage est un nom « convivial » pour le périphérique. Vous pouvez l'afficher dans l'interface utilisateur de votre application, mais rien ne garantit qu'il soit localisé. GameInput recherche cette chaîne à plusieurs emplacements, et l'une des dernières solutions de repli est le microprogramme du périphérique.

Le nom d'affichage ne change pas pendant toute la durée de vie de l'objet de périphérique.

L'exemple suivant récupère le nom d'affichage d'un périphérique.

```cpp theme={null}
std::string GetDeviceDisplayName(IGameInputDevice* device)
{
    const uint32_t size = device->GetDisplayName(0, nullptr);
    if (size == 0)
    {
        return {};
    }

    std::vector<char> buffer(size);
    device->GetDisplayName(size, buffer.data());

    return std::string(buffer.data());
}
```

Dans GameInput v3 et les versions antérieures, ces informations étaient disponibles dans le membre `displayName` 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)\
[IGameInputDevice](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/igameinputdevice.md)\
[IGameInputDevice::GetPnpPath](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getpnppath.md)

## Historique des versions

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


## Related topics

- [IGameInputDevice::GetPnpPath](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getpnppath.md)
- [IGameInputDevice::GetDeviceFamily](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getdevicefamily.md)
- [IGameInputDevice::GetDeviceId](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getdeviceid.md)
- [IGameInputDevice::GetXInputDeviceIndex](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getxinputdeviceindex.md)
- [IGameInputDevice::GetSupportedInput](https://docs.xbox.com/fr-CA/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedinput.md)