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

> Obtiene el nombre para mostrar descriptivo del dispositivo de entrada como una cadena UTF-8.

Obtiene el nombre para mostrar descriptivo del dispositivo de entrada como una cadena UTF-8.

## Sintaxis

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

### Parámetros

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

El tamaño, en bytes, del búfer al que apunta *buffer*. Pase 0 para consultar el tamaño necesario.

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

El búfer que recibe el nombre para mostrar UTF-8 terminado en NULL. Pase `nullptr` para consultar el tamaño necesario.

### Valor devuelto

Tipo: uint32\_t

El tamaño, en bytes, del búfer necesario para contener el nombre para mostrar, incluido el terminador NULL.

## Comentarios

El método escribe el nombre para mostrar en *buffer* solo si *buffer* no es `nullptr` y *bufferByteCount* es mayor o igual que el tamaño necesario. De lo contrario, el búfer no se modifica. Para recuperar el nombre para mostrar, llame al método una vez con un valor de *bufferByteCount* de 0 y un valor de *buffer* de `nullptr` para obtener el tamaño necesario, asigne un búfer de ese tamaño y, a continuación, vuelva a llamar al método.

Si el dispositivo no tiene un nombre para mostrar, el tamaño necesario es 1 y el método escribe una cadena vacía.

El nombre para mostrar es un nombre "descriptivo" del dispositivo. Puede mostrarlo en la interfaz de usuario de la aplicación, pero no se garantiza que esté localizado. GameInput busca esta cadena en varias ubicaciones, y una de las últimas alternativas es el firmware del dispositivo.

El nombre para mostrar no cambia durante la vida útil del objeto de dispositivo.

En el siguiente ejemplo se recupera el nombre para mostrar de un 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());
}
```

En GameInput v3 y versiones anteriores, esta información estaba disponible en el miembro `displayName` de la estructura [GameInputDeviceInfo](https://docs.xbox.com/es/reference/input/gameinput/deprecated/structs/gameinputdeviceinfo.md) devuelta por [IGameInputDevice::GetDeviceInfo](https://docs.xbox.com/es/reference/input/gameinput/deprecated/interfaces/igameinputdevice/methods/igameinputdevice_getdeviceinfo.md).

## Requisitos

**Encabezado:** GameInput.h

**Biblioteca:** gameinput.lib

**Plataformas compatibles:** Windows, consolas de la familia XBOX One y consolas XBOX Series

## Consulte también

[Información general de GameInput](https://docs.xbox.com/es/build/core-features/common/input/overviews/input-overview.md)\
[IGameInputDevice](https://docs.xbox.com/es/reference/input/gameinput/interfaces/igameinputdevice/igameinputdevice.md)\
[IGameInputDevice::GetPnpPath](https://docs.xbox.com/es/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getpnppath.md)

## Historial de versiones

| Versión | Cambios |
| - | - |
| **v4** | Se introdujo. |


## Related topics

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