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

Returns the properties of the current closed caption.

## Syntax

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

### Parameters

*properties*   \_Out\_\
Type: [XClosedCaptionProperties\*](/reference/system/xaccessibility/structs/xclosedcaptionproperties)

When the function returns, *properties* contains the current closed caption properties.

### Return value

Type: HRESULT

HRESULT if closed captions are enabled and *properties* contains the current [XClosedCaptionProperties](/reference/system/xaccessibility/structs/xclosedcaptionproperties). Otherwise, returns an error code.\
For a list of error codes, see [Error Codes](/reference/errorcodes).

## Remarks

<Note>This function isn't safe to call on a time-sensitive thread. For more information, see [Time-sensitive threads](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads).</Note>

For this function to be successful, closed captions must be enabled.
The user must enable the closed captions feature in the UI of the Game title.
If the user enabled closed captions, your Game title can flag the status of closed captions by calling [XClosedCaptionSetEnabled](/reference/system/xaccessibility/functions/xclosedcaptionsetenabled).

The following example demonstrates how to return the closed caption properties.

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

## Requirements

**Header:** XAccessibility.h

**Library:** xgameruntime.lib

**Supported platforms:** Windows, XBOX One family consoles and XBOX Series consoles

## Conceptual documentation

* [Time-sensitive threads](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## See also

[XAccessibility](/reference/system/xaccessibility/xaccessibility_members)

[XClosedCaptionProperties](/reference/system/xaccessibility/structs/xclosedcaptionproperties)

[XClosedCaptionSetEnabled](/reference/system/xaccessibility/functions/xclosedcaptionsetenabled)


## Related topics

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