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

# XtfWaitForConsoleState

> XtfWaitForConsoleState

# XtfWaitForConsoleState

Bloqueia a execução até que os estados de console especificados sejam atingidos ou ocorra um tempo limite.

## Sintaxe

```cpp theme={null}
HRESULT XtfWaitForConsoleState(  
         PCWSTR address,  
         UINT32 consoleState,  
         const UINT32 timeoutMS  
)  
```

<a id="parametersSection" />

### Parâmetros

*address*\
Tipo: PCWSTR

\[in] O endereço do console.

*consoleState*\
Tipo: UINT32

\[in] Uma combinação OR bit a bit de sinalizadores que indicam o estado atual do console. Este parâmetro dá suporte aos seguintes sinalizadores:

| Sinalizador | Valor | Descrição |
| - | - | - |
| XTF\_SYSTEM\_OS\_READY | 0x0001 | O System OS está pronto para comunicações do XBOX Tools Framework (XTF). |
| XTF\_TITLE\_OS\_READY | 0x0002 | O Game OS está pronto para comunicações do XTF.\<br>Este sinalizador é equivalente aos sinalizadores `XTF_TITLESTATE_TITLEOSRUNNING` e `XTF_TITLESTATE_TITLENETWORK_READY` retornados pela função [XtfGetTitleOSState](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgettitleosstate-xtfapi-xbox-windows-m). |
| XTF\_TITLE\_PROCESS\_READY | 0x0004 | O processo do jogo está pronto para comunicações do XTF.\<br>Este sinalizador é equivalente ao sinalizador `XTF_TITLESTATE_TITLERUNNING` retornado pela função `XtfGetTitleOSState`. |

*timeoutMS*\
Tipo: UINT32

\[in] O tempo limite, em milissegundos, antes que a função retorne `ERROR_TIMEOUT`.

<a id="retvalSection" />

### Valor de retorno

Tipo: HRESULT

Retorna `S_OK` se tiver êxito; caso contrário, retorna um dos seguintes códigos de erro HRESULT.

| Código de erro | Descrição |
| - | - |
| ERROR\_TIMEOUT | O tempo limite especificado em *timeoutMS* expirou e os estados especificados em *consoleState* não foram atingidos. |
| E\_INVALIDARG | Os valores passados em *address* ou *consoleState* não eram válidos. |

<a id="remarksSection" />

## Comentários

Esta função executa um loop a cada 250 milissegundos, validando o estado atual do console em relação aos estados especificados em `consoleState`. Se os estados especificados em `consoleState` não corresponderem ao estado atual do console dentro do tempo especificado em `timeoutMS`, a função retornará `ERROR_TIMEOUT`; caso contrário, a função interromperá o loop e retornará `S_OK`. Para obter mais informações sobre o System OS e o Game OS, confira Para uma introdução completa, confira [O que é o Microsoft Game Development Kit? (tópico sob NDA)](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/intro/introduction).

## Requisitos

**Cabeçalho:** xtfapi.h

**Biblioteca:** XtfApi.lib

**Plataformas com suporte:** Windows (para ferramentas de console XBOX)

<a id="seealsoSection" />

## Confira também

[Erros de transporte do XTF (tópico sob NDA)](/pt-BR/tools/tools-console/commandlinetools/xtf-transport-errors)\
[APIs adicionais do Xtf](/pt-BR/reference/tools/xtf/xtfapi/atoc-xtfapi)


## Related topics

- [Wait](/pt-BR/reference/graphics/d3d12/interfaces/id3d12commandqueue/methods/id3d12commandqueue_wait_public.md)
- [XtfGetTitleOSState](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgettitleosstate-xtfapi-xbox-windows-m.md)
- [IXtfApplicationClient::QueryExecutionState](/pt-BR/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/queryexecutionstate-ixtfapplicationclient-xtfapplication-xbox-microsoft-m.md)
- [Método IXtfRemoteRunClient::Run](/pt-BR/reference/tools/xtf/xtfremoterun/classes/IXtfRemoteRunClient/methods/ixtfremoterunclient_run.md)
- [XGameStreamingUnregisterConnectionStateChanged](/pt-BR/reference/system/xgamestreaming/functions/xgamestreamingunregisterconnectionstatechanged.md)