通过

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)。

备注

注意

在时间敏感线程上调用此函数是不安全的。 有关详细信息，请参阅时间敏感线程。

结合使用 TitleID 和服务配置 ID (SCID)，沙盒 ID 对于开发 Xbox Live 游戏和应用程序至关重要。 沙盒 ID 标识您的沙盒，沙盒在开发过程中为您的开发工具包提供内容隔离。 内容隔离可确保您有一个干净的环境来开发和测试您的游戏。

注意

沙盒 ID 区分大小写。

对于 Xbox 和电脑设备，沙盒 ID 存储在设备上。 如果找不到沙盒 ID，或你没有访问沙盒 ID 的权限，则沙盒 ID 默认为“RETAIL”。

如果实际上游戏在零售环境中运行，则此函数也将返回“RETAIL”。

要求

头文件：XSystem.h

库：xgameruntime.lib

支持平台：Windows、Xbox One 系列主机和 Xbox Series 主机

另请参阅

配置开发工具包设置（NDA 主题）
设置用于 Xbox Live 开发的沙盒
XSystemGetConsoleId
XSystem