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

> Obtém o nome de exibição amigável do dispositivo de entrada como uma cadeia de caracteres UTF-8.

Obtém o nome de exibição amigável do dispositivo de entrada como uma cadeia de caracteres UTF-8.

## Sintaxe

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

### Parâmetros

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

O tamanho, em bytes, do buffer apontado por *buffer*. Passe 0 para consultar o tamanho necessário.

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

O buffer que recebe o nome de exibição UTF-8 terminado em nulo. Passe `nullptr` para consultar o tamanho necessário.

### Valor retornado

Tipo: uint32\_t

O tamanho, em bytes, do buffer necessário para armazenar o nome de exibição, incluindo o terminador nulo.

## Comentários

O método grava o nome de exibição em *buffer* somente se *buffer* não for `nullptr` e *bufferByteCount* for maior ou igual ao tamanho necessário. Caso contrário, o buffer não é modificado. Para recuperar o nome de exibição, chame o método uma vez com *bufferByteCount* igual a 0 e *buffer* igual a `nullptr` para obter o tamanho necessário, aloque um buffer desse tamanho e, em seguida, chame o método novamente.

Se o dispositivo não tiver um nome de exibição, o tamanho necessário será 1 e o método gravará uma cadeia de caracteres vazia.

O nome de exibição é um nome "amigável" para o dispositivo. Você pode exibi-lo na interface do usuário do seu aplicativo, mas não há garantia de que ele esteja localizado. O GameInput pesquisa essa cadeia de caracteres em vários locais, e um dos últimos fallbacks é o firmware do dispositivo.

O nome de exibição não muda durante o tempo de vida do objeto de dispositivo.

O exemplo a seguir recupera o nome de exibição de um dispositivo.

```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());
}
```

No GameInput v3 e anteriores, essas informações estavam disponíveis no membro `displayName` da estrutura [GameInputDeviceInfo](https://docs.xbox.com/pt-BR/reference/input/gameinput/deprecated/structs/gameinputdeviceinfo.md) retornada por [IGameInputDevice::GetDeviceInfo](https://docs.xbox.com/pt-BR/reference/input/gameinput/deprecated/interfaces/igameinputdevice/methods/igameinputdevice_getdeviceinfo.md).

## Requisitos

**Cabeçalho:** GameInput.h

**Biblioteca:** gameinput.lib

**Plataformas com suporte:** Windows, consoles da família XBOX One e consoles XBOX Series

## Confira também

[Visão geral do GameInput](https://docs.xbox.com/pt-BR/build/core-features/common/input/overviews/input-overview.md)\
[IGameInputDevice](https://docs.xbox.com/pt-BR/reference/input/gameinput/interfaces/igameinputdevice/igameinputdevice.md)\
[IGameInputDevice::GetPnpPath](https://docs.xbox.com/pt-BR/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getpnppath.md)

## Histórico de versões

| Versão | Alterações |
| - | - |
| **v4** | Introduzido. |


## Related topics

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