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 本体