> ## 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 du délai d'expiration de l'écran.

## Syntaxe

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

### Paramètres

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

Pointeur vers le handle du report du délai d'expiration 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-CA/reference/errorcodes).

## Remarques

<Note>Il n'est pas sécuritaire d'appeler cette fonction sur un thread sensible au temps. Pour plus d'informations, consultez [Threads sensibles au temps](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads).</Note>

Un report du délai d'expiration 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é, le délai d'expiration de l'écran survient. En réponse à l'expiration du délai de l'écran, les appareils peuvent assombrir l'affichage, activer l'écran de verrouillage ou éteindre l'écran. La durée d'inactivité requise avant l'expiration du délai de l'écran dépend des paramètres utilisateur de l'appareil. Si votre jeu effectue une activité qui ne nécessite aucune interaction de l'utilisateur, comme le chargement de ressources de jeu ou l'affichage d'une longue cinématique, les expirations du délai de l'écran peuvent être gênantes. Vous pouvez empêcher ces expirations en acquérant un report du délai d'expiration de l'écran.

Pour acquérir un report du délai d'expiration de l'écran, appelez d'abord **XDisplayAcquireTimeoutDeferral** pour acquérir un handle de report du délai d'expiration de l'écran, puis appelez [XDisplayCloseTimeoutDeferralHandle](/fr-CA/reference/system/xdisplay/functions/xdisplayclosetimeoutdeferralhandle) pour fermer le handle lorsqu'il n'est plus nécessaire. Les reports du délai d'expiration 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 du délai d'expiration de l'écran, vous devez fermer ce handle en appelant **XDisplayCloseTimeoutDeferralHandle**. Plusieurs handles de report du délai d'expiration de l'écran peuvent être acquis, et le délai d'expiration de l'écran n'est réactivé pour le jeu qu'une fois tous ces handles fermés.</Note>

<Note>L'assombrissement de l'écran ne se produit pas pendant qu'un titre est en cours de débogage actif.</Note>

L'exemple suivant lit une longue cinématique d'introduction après avoir appelé **XDisplayAcquireTimeoutDeferral** pour acquérir un nouveau handle de report du délai d'expiration de l'écran. Si le nouveau handle est acquis avec succès, la longue cinématique d'introduction peut être lue sans que le délai de l'écran expire 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 du délai d'expiration de l'écran fermés, le délai d'expiration de l'écran peut de nouveau survenir 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 sensibles au temps](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## Voir aussi

[XDisplayCloseTimeoutDeferralHandle](/fr-CA/reference/system/xdisplay/functions/xdisplayclosetimeoutdeferralhandle)\
[XDisplay](/fr-CA/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)