Skip to main content

XSystemGetXboxLiveSandboxId

检索 XBOX Live 沙盒 ID。

Syntax

Parameters

sandboxIdSize _In_
类型:size_t
sandboxId 的大小(以字节为单位)。此值必须大于或等于 XSystem.h 中定义的 XSystemXboxLiveSandboxIdMaxBytes 常量。 sandboxId _Out_writes_bytes_to_(sandboxIdSize,*sandboxIdUsed)
类型:char*
将接收沙盒 ID 的字符缓冲区。 sandboxIdUsed _Out_opt_
类型:size_t*
返回的 sandboxId 缓冲区的实际大小(以字节为单位)。

Return value

类型:HRESULT 成功时返回 S_OK;否则,返回错误代码。有关错误代码列表,请参阅错误代码。如果函数失败是因为 sandboxIdSize 设置的值小于 XSystemXboxLiveSandboxIdMaxBytes,则返回值将设置为 HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)

Remarks

沙盒 ID 与 TitleID 和服务配置 ID (SCID) 一起,对 XBOX Live 主机游戏和应用程序的开发至关重要。沙盒 ID 用于标识你的沙盒,在开发期间为开发工具包提供内容隔离。内容隔离可确保你拥有一个用于开发和测试主机游戏的干净环境。
沙盒 ID 区分大小写。
对于 XBOX 和 PC 设备,沙盒 ID 存储在设备上。如果找不到沙盒 ID,或者你没有访问沙盒 ID 的权限,则沙盒 ID 默认为“RETAIL”。 如果你的游戏实际上是在零售环境中运行,此函数也会返回“RETAIL”。

Requirements

头文件: XSystem.h 库: xgameruntime.lib 受支持的平台: Windows、XBOX One 系列主机和 XBOX Series 主机

Conceptual documentation

See also

配置开发工具包设置(NDA 主题)
为 XBOX Live 开发设置沙盒
XSystemGetConsoleId
XSystem
最后修改于 2026年8月24日