XSystemGetConsoleId

  • [アーティクル]

現在のデバイスの本体 ID を返します。

構文

HRESULT XSystemGetConsoleId(  
         size_t consoleIdSize,  
         char* consoleId,  
         size_t* consoleIdUsed  
)

パラメーター

consoleIdSize _In_
型: size_t

consoleId のサイズ (バイト単位)。 この値は、XSystem.h で定義されている XSystemConsoleIdBytes 定数以上である必要があります。

consoleId _Out_writes_bytes_to_(consoleIdSize,*consoleIdUsed)
型: char*

本体 ID を受け取る文字バッファー。

consoleIdUsed _Out_opt_
型: size_t*

返された consoleId バッファーのサイズ (バイト単位)。

戻り値

型: HRESULT

正常に実行された場合は S_OK が返され、それ以外の場合はエラー コードが返されます。 エラー コードの一覧については、「エラー コード」を参照してください。 consoleIdSize が XSystemConsoleIdBytes より小さい値に設定されているために関数が失敗した場合、戻り値は HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) に設定されます。

解説

注意

この関数は、時間依存のスレッドで呼び出すのに安全ではありません。 詳細については、「時間依存のスレッド」を参照してください。

コンソール ID は、開発シナリオでのみ Xbox Live 用の Xbox デバイスを一意に識別します。 コンソール ID は、ログ記録や管理の目的でコンソールを識別するために使用されます。たとえば、分析情報をキャプチャしたり、開発環境で再起動する開発キットを特定したりすることができます。 この関数によって返されるIDは、[設定] \ [システム] \ [本体情報]に表示されるコンソール ID 一致します。

Xbox デバイスでは、本体 ID はデバイスに格納されています。 本体 ID が見つからない場合、または本体 ID にアクセスするためのアクセス許可がない場合、本体 ID の既定値は 00000000.00000000.00000000.00000000.00 です。 PC デバイスでは、本体 ID の既定値は常に 00000000.00000000.00000000.00000000.00 です。

RETAIL では、この関数は常に00000000.00000000.00000000.00000000.00を返します。 ゲームが小売りを含むすべての状況で使用できる識別子を必要としている場合、2 つの可能性があります。

  • アプリケーションがシングル サインオン (SSO) を使用している場合は、この関数によって返される ID ではなく、XSTS SSO トークンのペアワイズ ID を使用する必要があります。
  • それ以外の場合は、XSystemGetAppSpecificDeviceId 関数を使用します。

要件

ヘッダー: XSystem.h

ライブラリ: xgameruntime.lib

サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体

関連項目

開発キットのアクティブ化 (NDA トピック)
XSystemGetXboxLiveSandbodId
XSystem