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

# XClosedCaptionGetProperties

> XClosedCaptionGetProperties

# XClosedCaptionGetProperties

Retorna as propriedades das legendas ocultas atuais.

## Sintaxe

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

### Parâmetros

*properties*   \_Out\_\
Tipo: [XClosedCaptionProperties\*](/pt-BR/reference/system/xaccessibility/structs/xclosedcaptionproperties)

Quando a função retorna, *properties* contém as propriedades atuais das legendas ocultas.

### Valor retornado

Tipo: HRESULT

HRESULT se as legendas ocultas estiverem habilitadas e *properties* contiver as [XClosedCaptionProperties](/pt-BR/reference/system/xaccessibility/structs/xclosedcaptionproperties) atuais. Caso contrário, retorna um código de erro.\
Para obter uma lista de códigos de erro, confira [Códigos de erro](/pt-BR/reference/errorcodes).

## Comentários

<Note>Não é seguro chamar esta função em um thread sensível ao tempo. Para obter mais informações, confira [Threads sensíveis ao tempo](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads).</Note>

Para que esta função seja bem-sucedida, as legendas ocultas devem estar habilitadas.
O usuário deve habilitar o recurso de legendas ocultas na interface do usuário do título do jogo.
Se o usuário habilitou as legendas ocultas, o título do jogo poderá sinalizar o status das legendas ocultas chamando [XClosedCaptionSetEnabled](/pt-BR/reference/system/xaccessibility/functions/xclosedcaptionsetenabled).

O exemplo a seguir demonstra como retornar as propriedades das legendas ocultas.

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

## Requisitos

**Cabeçalho:** XAccessibility.h

**Biblioteca:** xgameruntime.lib

**Plataformas com suporte:** Windows, consoles da família XBOX One e consoles XBOX Series

## Documentação conceitual

* [Threads sensíveis ao tempo](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## Confira também

[XAccessibility](/pt-BR/reference/system/xaccessibility/xaccessibility_members)

[XClosedCaptionProperties](/pt-BR/reference/system/xaccessibility/structs/xclosedcaptionproperties)

[XClosedCaptionSetEnabled](/pt-BR/reference/system/xaccessibility/functions/xclosedcaptionsetenabled)


## Related topics

- [XClosedCaptionProperties](/pt-BR/reference/system/xaccessibility/structs/xclosedcaptionproperties.md)
- [XClosedCaptionFontStyle](/pt-BR/reference/system/xaccessibility/enums/xclosedcaptionfontstyle.md)
- [XClosedCaptionFontEdgeAttribute](/pt-BR/reference/system/xaccessibility/enums/xclosedcaptionfontedgeattribute.md)
- [XClosedCaptionSetEnabled](/pt-BR/reference/system/xaccessibility/functions/xclosedcaptionsetenabled.md)
- [XAG 104: Legendas e legendas descritivas](/pt-BR/build/game-principles/accessibility/xag-deep-dives/xag-104-subtitles-captions.md)