Skip to main content

XClosedCaptionGetProperties

現在のクローズド キャプションのプロパティを返します。

構文

パラメーター

properties   _Out_
型: XClosedCaptionProperties*
関数から戻ったとき、properties には現在のクローズド キャプション プロパティが格納されます。

戻り値

型: HRESULT クローズド キャプションが有効で、properties に現在の XClosedCaptionProperties が含まれる場合は HRESULT。 それ以外の場合はエラー コードを返します。
エラー コードの一覧については、「エラー コード」を参照してください。

解説

この関数は、時間依存スレッドで呼び出しても安全ではありません。 詳細については、「Time-sensitive threads」を参照してください。
この関数を成功させるには、クローズド キャプションを有効にする必要があります。 ユーザーがゲーム タイトルの UI でクローズド キャプション機能を有効にする必要があります。 ユーザーがクローズド キャプションを有効にした場合、ゲーム タイトルは XClosedCaptionSetEnabled を呼び出すことでクローズド キャプションのステータスをフラグとして設定できます。 次の例は、クローズド キャプション プロパティを取得する方法を示しています。

要件

ヘッダー: XAccessibility.h ライブラリ: xgameruntime.lib サポートされているプラットフォーム: Windows、XBOX One ファミリー本体、XBOX Series 本体

概念ドキュメント

関連項目

XAccessibility XClosedCaptionProperties XClosedCaptionSetEnabled
最終更新日 2026年8月24日