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

# XDisplayAcquireTimeoutDeferral

> XDisplayAcquireTimeoutDeferral

# XDisplayAcquireTimeoutDeferral

Acquiert un report de mise en veille de l'écran.

## Syntaxe

```cpp theme={null}
HRESULT XDisplayAcquireTimeoutDeferral(  
         XDisplayTimeoutDeferralHandle* handle  
)  
```

### Paramètres

*handle*   \_Out\_\
Type : XDisplayTimeoutDeferralHandle\*

Pointeur vers le handle du report de mise en veille de l'écran.

### Valeur de retour

Type : [HRESULT](https://learn.microsoft.com/openspecs/windows_protocols/ms-erref/0642cb2f-2075-4469-918c-4441e69c548a)

Retourne **S\_OK** en cas de réussite ; sinon, retourne un code d'erreur. Pour obtenir la liste des codes d'erreur, consultez [Codes d'erreur](/fr/reference/errorcodes).

## Remarques

<Note>Il n'est pas sûr d'appeler cette fonction sur un thread soumis à des contraintes de temps. Pour plus d'informations, consultez [Threads soumis à des contraintes de temps](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads).</Note>

Un report de mise en veille de l'écran garantit que l'écran ne s'assombrira pas, ne se verrouillera pas et ne s'éteindra pas pendant l'inactivité de l'utilisateur. Après un certain temps d'inactivité, une mise en veille de l'écran se produit. En réponse à une mise en veille de l'écran, les appareils peuvent assombrir l'affichage, activer l'écran de verrouillage ou éteindre l'affichage. La durée d'inactivité requise avant la mise en veille de l'écran dépend des paramètres utilisateur de l'appareil. Si votre jeu effectue une activité qui ne nécessite pas d'interaction de l'utilisateur, comme le chargement de ressources de jeu ou l'affichage d'une longue cinématique, les mises en veille de l'écran peuvent être gênantes. Vous pouvez empêcher les mises en veille de l'écran en acquérant un report de mise en veille de l'écran.

Pour acquérir un report de mise en veille de l'écran, appelez d'abord **XDisplayAcquireTimeoutDeferral** pour acquérir un handle pour le report de mise en veille de l'écran, puis appelez [XDisplayCloseTimeoutDeferralHandle](/fr/reference/system/xdisplay/functions/xdisplayclosetimeoutdeferralhandle) pour fermer le handle lorsqu'il n'est plus nécessaire. Les reports de mise en veille de l'écran sont ignorés si le jeu perd le focus, et ils sont libérés si le jeu se ferme.

<Note>Si vous utilisez cette fonction pour acquérir un handle de report de mise en veille de l'écran, vous devez fermer ce handle en appelant **XDisplayCloseTimeoutDeferralHandle**. Plusieurs handles de report de mise en veille de l'écran peuvent être acquis, et la mise en veille de l'écran n'est réactivée pour le jeu qu'une fois tous les handles de report de mise en veille de l'écran fermés.</Note>

<Note>L'assombrissement de l'écran n'a pas lieu pendant le débogage actif d'un titre.</Note>

L'exemple suivant lit une longue cinématique d'introduction après avoir appelé **XDisplayAcquireTimeoutDeferral** pour acquérir un nouveau handle de report de mise en veille de l'écran. Si le nouveau handle est acquis avec succès, la longue cinématique d'introduction peut être lue sans que l'écran se mette en veille en raison de l'inactivité de l'utilisateur. Une fois la lecture de la cinématique terminée, l'exemple appelle **XDisplayCloseTimeoutDeferralHandle** pour fermer le handle. Une fois tous les handles de report de mise en veille de l'écran fermés, la mise en veille de l'écran peut de nouveau se produire en raison de l'inactivité de l'utilisateur.

```cpp theme={null}
void Game::PlayIntroCutscene()
{
    XDisplayTimeoutDeferralHandle handle;

    // Try to acquire a new timeout deferral handle.
    if (SUCCEEDED(XDisplayAcquireTimeoutDeferral(&handle)))
    {
        // The newly-opened timeout deferral handle prevents the display
        // from dimming over the game if the user goes idle.
        // 
        // At this point, the long intro cutscene can play without dimmming.
    }

    // Once the cutscene has completed playing, 
    // close the timeout deferral handle.
    XDisplayCloseTimeoutDeferralHandle(handle);

    // If there are no open timeout deferral handles, the display can
    // once again dim over the game if the user goes idle.
}
```

## Configuration requise

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

**Bibliothèque :** xgameruntime.lib

**Plateformes prises en charge :** Windows, consoles de la famille XBOX One et consoles XBOX Series

## Documentation conceptuelle

* [Threads soumis à des contraintes de temps](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## Voir aussi

[XDisplayCloseTimeoutDeferralHandle](/fr/reference/system/xdisplay/functions/xdisplayclosetimeoutdeferralhandle)\
[XDisplay](/fr/reference/system/xdisplay/xdisplay_members)


## Related topics

- [XDisplayAcquireTimeoutDeferral](/reference/system/xdisplay/functions/xdisplayacquiretimeoutdeferral.md)
- [XDisplay](/reference/system/xdisplay/xdisplay_members.md)
- [XDisplayCloseTimeoutDeferralHandle](/reference/system/xdisplay/functions/xdisplayclosetimeoutdeferralhandle.md)