XClosedCaptionGetProperties

返回当前隐藏字幕的属性。

语法

HRESULT XClosedCaptionGetProperties(  
         XClosedCaptionProperties* properties  
)  

参数

properties _Out_
类型:XClosedCaptionProperties*

在该函数返回时,properties 包含当前隐藏字幕的属性。

返回值

类型:HRESULT

如果启用了隐藏字幕,并且 properties 包含当前 XClosedCaptionProperties,则为 HRESULT。 否则,返回错误代码。
有关错误代码的列表,请参阅错误代码

备注

注意

在时间敏感线程上调用此函数是不安全的。 有关详细信息,请参阅时间敏感线程

为使此函数成功,必须启用隐式字幕。 用户必须在游戏名称的 UI 中启用隐藏字幕功能。 如果用户启用了隐藏字幕,则您的游戏可以通过调用 XClosedCaptionSetEnabled 来标记隐藏字幕的状态。

下面的示例演示如何返回隐藏字幕属性。

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

要求

头文件:XAccessibility.h

库:xgameruntime.lib

支持平台:Windows、Xbox One 系列主机和 Xbox Series 主机

另请参阅

XAccessibility

XClosedCaptionProperties

XClosedCaptionSetEnabled