XSystemGetXboxLiveSandboxId
Xbox Live のサンドボックス ID を取得します。
構文
HRESULT XSystemGetXboxLiveSandboxId(
size_t sandboxIdSize,
char* sandboxId,
size_t* sandboxIdUsed
)
パラメーター
sandboxIdSize _In_
型: size_t
sandboxId のサイズ (バイト単位)。 この値は、XSystem.h で定義されている XSystemXboxLiveSandboxIdMaxBytes 定数以上である必要があります。
sandboxId _Out_writes_bytes_to_(sandboxIdSize,*sandboxIdUsed)
型: char*
サンドボックス ID を受け取る文字バッファー。
sandboxIdUsed _Out_opt_
型: size_t*
返された sandboxId バッファーの実際のサイズ (バイト単位)。
戻り値
型: HRESULT
正常に実行された場合は S_OK が返され、それ以外の場合はエラー コードが返されます。 エラー コードの一覧については、「エラー コード」を参照してください。 sandboxIdSize が XSystemXboxLiveSandboxIdMaxBytes より小さい値に設定されているために関数が失敗した場合、戻り値は HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) に設定されます。
解説
注意
この関数は、時間依存のスレッドで呼び出すのに安全ではありません。 詳細については、「時間依存のスレッド」を参照してください。
タイトル ID とサービス コンフィグ ID (SCID) とともに、サンドボックス ID は Xbox Live のタイトルとアプリケーションの開発のために重要です。 サンドボックス ID はサンドボックスを識別します。これにより、開発中に開発キットのコンテンツの分離を提供します。 コンテンツの分離により、タイトルの開発とテストのためのクリーンな環境が確保されます。
注意
サンド ボックス ID は大文字と小文字を区別します。
Xbox デバイスと PC デバイスでは、サンドボックス ID はデバイスに格納されます。 サンドボックス ID が見つからない場合、またはサンドボックス ID へのアクセス許可がない場合、サンドボックス ID は既定で「RETAIL」になります。
実際にゲームが小売環境で実行されている場合にも、この関数は「RETAIL」を返します。
要件
ヘッダー: XSystem.h
ライブラリ: xgameruntime.lib
サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体
関連項目
開発キット設定の構成 (NDA トピック)認可が必須です
Xbox Live 開発のためのサンドボックスのセットアップ
XSystemGetConsoleId
XSystem