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

# XGameUiTextEntryOpen

> XGameUiTextEntryOpen

# XGameUiTextEntryOpen

Abre um teclado virtual em que o título é responsável por renderizar o texto. Atualmente
não implementado na área de trabalho.

## Sintaxe

```cpp theme={null}
HRESULT XGameUiTextEntryOpen(  
         const XGameUiTextEntryOption* options,
         uint32_t maxLength,
         const char* initialText,
         uint32_t initialCursorIndex,
         XGameUiTextEntryHandle* handle 
)  
```

### Parâmetros

*options*   \_In\_\
Tipo: [XGameUiTextEntryOptions](/pt-BR/reference/system/xgameui/structs/xgameuitextentryoptions)

Indica o conjunto inicial de opções a serem aplicadas ao teclado quando ele é aberto, como o posicionamento
e a configuração do teclado.

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

Número máximo de caracteres que o usuário pode inserir no teclado virtual. Esse número não deve
ser maior que 32K.

*initialText*   \_In\_\_opt\_z\_\
Tipo: const char\*

Cadeia de caracteres terminada em nulo que é preenchida inicialmente no teclado virtual.

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

Índice de byte inicial do cursor em relação ao caractere inicial.

*handle*   \_Out\_\
Tipo: XGameUiTextEntryHandle

Identificador do teclado virtual recém-aberto.

### Valor retornado

Tipo: HRESULT

Código HRESULT de êxito ou erro. Para obter uma lista de códigos de erro, consulte [Códigos de erro](/pt-BR/reference/errorcodes).

| Código de retorno | Descrição |
| - | - |
| S\_OK | A operação foi bem-sucedida. |
| E\_ACCESSDENIED | Uma caixa de diálogo já está sendo exibida. |

## Comentários

Essa função retornará assim que puder obter o identificador, mesmo que o teclado virtual ainda não esteja
visível. Todas as outras funções **XGameUiTextEntry** podem ser chamadas com segurança assim que o identificador é
retornado.

O exemplo a seguir demonstra os conceitos básicos de como usar as funções **XGameUiTextEntry**.

```cpp theme={null}
// Somewhere in the main game loop
// ...
bool someSignal;
bool showingKeyboard;
uint32_t KEYBOARD_MAX_CHARACTERS = 256; 
uint32_t KEYBOARD_BUFFER_SIZE = KEYBOARD_MAX_CHARACTERS * 4;

XGameUiTextEntryHandle keyboardInstance;

if (someSignal)
{
    XGameUiTextEntryOptions options;
    options.inputScope = XGameUiTextEntryInputScope::Default;
    options.positionHint = XGameUiTextEntryPositionHint::Bottom;
    options.flags = XGameUiTextEntryVisibilityFlags::Default;

    if (SUCCEEDED(XGameUiTextEntryOpen(&options, 
                                       nullptr, 
                                       0, 
                                       KEYBOARD_MAX_CHARACTERS, 
                                       &keyboardInstance)))
    {
        showingKeyboard = true;
    }
}

if (showingKeyboard)
{
    char* buffer[KEYBOARD_BUFFER_SIZE];
    uint32_t cursorPosition;
    XGameUiTextEntryChangeTypeFlags changeType;

    if (SUCCEEDED(XGameUiTextEntryGetState(
        keyboardInstance,
        &changeType,
        &cursorPosition,
        nullptr,
        nullptr,
        KEYBOARD_BUFFER_SIZE,
        buffer)))
    {
        if (changeType & XGameUiTextEntryChangeTypeFlags::TextChanged)
        {
            // Copy text for in-game rendering
            RenderTextInGame(buffer, cursorPosition);

            // Assuming the game doesn't want multi-line input
            if (strstr(buffer, "\n")
            {
                XGameUiTextEntryClose(keyboardInstance);
                showingKeyboard = false;
            }
        }

        if (showingKeyboard && (changeType & XGameUiTextEntryChangeTypeFlags::KeyboardDismissed))
        {
            XGameUiTextEntryClose(keyboardInstance);
            showingKeyboard = false;
        }    
    }
}
```

## Requisitos

**Cabeçalho:** XGameUI.h

**Biblioteca:** xgameruntime.lib

**Plataformas compatíveis:** Windows, consoles da família XBOX One e consoles XBOX Series

## Confira também

[XGameUI](/pt-BR/reference/system/xgameui/xgameui_members)\
[Suporte ao teclado virtual](/pt-BR/build/core-features/common/input/overviews/virtualkeyboardsupport)


## Related topics

- [XGameUiTextEntryOpen](/reference/system/xgameui/functions/xgameuitextentryopen.md)
- [XGameUiTextEntryOptions](/reference/system/xgameui/structs/xgameuitextentryoptions.md)
- [XGameUiTextEntryClose](/reference/system/xgameui/functions/xgameuitextentryclose.md)