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

# XClosedCaptionGetProperties

> XClosedCaptionGetProperties

# XClosedCaptionGetProperties

Renvoie les propriétés des sous-titres actuels.

## Syntaxe

```cpp theme={null}
HRESULT XClosedCaptionGetProperties(  
         XClosedCaptionProperties* properties  
)  
```

### Paramètres

*properties*   \_Out\_\
Type : [XClosedCaptionProperties\*](https://docs.xbox.com/fr/reference/system/xaccessibility/structs/xclosedcaptionproperties.md)

Au retour de la fonction, *properties* contient les propriétés actuelles des sous-titres.

### Valeur de retour

Type : HRESULT

HRESULT si les sous-titres sont activés et que *properties* contient les [XClosedCaptionProperties](https://docs.xbox.com/fr/reference/system/xaccessibility/structs/xclosedcaptionproperties.md) actuelles. Sinon, renvoie un code d'erreur.\
Pour obtenir la liste des codes d'erreur, consultez [Codes d'erreur](https://docs.xbox.com/fr/reference/errorcodes.md).

## Remarques

> [!NOTE]
>
> Cette fonction ne peut pas être appelée sans risque sur un thread à durée critique. Pour plus d'informations, consultez [Threads à durée critique](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads).

Pour que cette fonction réussisse, les sous-titres doivent être activés.
L'utilisateur doit activer la fonctionnalité de sous-titres dans l'interface utilisateur du titre.
Si l'utilisateur a activé les sous-titres, votre titre peut signaler l'état des sous-titres en appelant [XClosedCaptionSetEnabled](https://docs.xbox.com/fr/reference/system/xaccessibility/functions/xclosedcaptionsetenabled.md).

L'exemple suivant montre comment renvoyer les propriétés des sous-titres.

```cpp theme={null}
XClosedCaptionProperties ccProperties;
if (SUCCEEDED(XClosedCaptionGetProperties(&ccProperties))
{
    // The game title can now access color and font settings in the ccProperties structure.
}
```

## Configuration requise

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

**Bibliothèque :** xgameruntime.lib

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

## Documentation conceptuelle

* [Threads à durée critique](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## Voir aussi

[XAccessibility](https://docs.xbox.com/fr/reference/system/xaccessibility/xaccessibility_members.md)

[XClosedCaptionProperties](https://docs.xbox.com/fr/reference/system/xaccessibility/structs/xclosedcaptionproperties.md)

[XClosedCaptionSetEnabled](https://docs.xbox.com/fr/reference/system/xaccessibility/functions/xclosedcaptionsetenabled.md)


## Related topics

- [XClosedCaptionProperties](https://docs.xbox.com/fr/reference/system/xaccessibility/structs/xclosedcaptionproperties.md)
- [XClosedCaptionFontStyle](https://docs.xbox.com/fr/reference/system/xaccessibility/enums/xclosedcaptionfontstyle.md)
- [XClosedCaptionFontEdgeAttribute](https://docs.xbox.com/fr/reference/system/xaccessibility/enums/xclosedcaptionfontedgeattribute.md)
- [XClosedCaptionSetEnabled](https://docs.xbox.com/fr/reference/system/xaccessibility/functions/xclosedcaptionsetenabled.md)
- [Xbox Accessibility Guideline 104](https://docs.xbox.com/fr/build/game-principles/accessibility/xag-deep-dives/xag-104-subtitles-captions.md)