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

Bloque l'exécution jusqu'à ce que les états de console spécifiés soient atteints ou qu'un délai d'expiration survienne.

## Syntaxe

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

<a id="parametersSection" />

### Paramètres

*address*\
Type : PCWSTR

\[in] L'adresse de la console.

*consoleState*\
Type : UINT32

\[in] Une combinaison OR au niveau du bit d'indicateurs qui indiquent l'état actuel de la console. Ce paramètre prend en charge les indicateurs suivants :

| Indicateur | Valeur | Description |
| - | - | - |
| XTF\_SYSTEM\_OS\_READY | 0x0001 | Le System OS est prêt pour les communications XBOX Tools Framework (XTF). |
| XTF\_TITLE\_OS\_READY | 0x0002 | Le Game OS est prêt pour les communications XTF.\<br>Cet indicateur équivaut aux indicateurs `XTF_TITLESTATE_TITLEOSRUNNING` et `XTF_TITLESTATE_TITLENETWORK_READY` retournés par la fonction [XtfGetTitleOSState](/fr-CA/reference/tools/xtf/xtfapi/functions/xtfgettitleosstate-xtfapi-xbox-windows-m). |
| XTF\_TITLE\_PROCESS\_READY | 0x0004 | Le processus du jeu est prêt pour les communications XTF.\<br>Cet indicateur équivaut à l'indicateur `XTF_TITLESTATE_TITLERUNNING` retourné par la fonction `XtfGetTitleOSState`. |

*timeoutMS*\
Type : UINT32

\[in] Le délai d'expiration, en millisecondes, avant que la fonction retourne `ERROR_TIMEOUT`.

<a id="retvalSection" />

### Valeur de retour

Type : HRESULT

Retourne `S_OK` en cas de réussite; sinon, retourne l'un des codes d'erreur HRESULT suivants.

| Code d'erreur | Description |
| - | - |
| ERROR\_TIMEOUT | Le délai spécifié dans *timeoutMS* est écoulé et les états spécifiés dans *consoleState* n'ont pas été atteints. |
| E\_INVALIDARG | Les valeurs passées dans *address* ou *consoleState* n'étaient pas valides. |

<a id="remarksSection" />

## Remarques

Cette fonction effectue une boucle toutes les 250 millisecondes, en validant l'état actuel de la console par rapport aux états spécifiés dans `consoleState`. Si les états spécifiés dans `consoleState` ne correspondent pas à l'état actuel de la console dans le délai spécifié dans `timeoutMS`, la fonction retourne `ERROR_TIMEOUT`; sinon, la fonction arrête la boucle et retourne `S_OK`. Pour plus d'informations sur le System OS et le Game OS, et pour une présentation complète, consultez [Qu'est-ce que le Microsoft Game Development Kit? (rubrique sous NDA)](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/intro/introduction).

## Configuration requise

**En-tête :** xtfapi.h

**Bibliothèque :** XtfApi.lib

**Plateformes prises en charge :** Windows (pour les outils de console XBOX)

<a id="seealsoSection" />

## Voir aussi

[Erreurs de transport XTF (rubrique sous NDA)](/fr-CA/tools/tools-console/commandlinetools/xtf-transport-errors)\
[API Xtf supplémentaires](/fr-CA/reference/tools/xtf/xtfapi/atoc-xtfapi)


## Related topics

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