Skip to main content

XGameStreamingGetSessionId

此 API 返回一个 null 结尾的不透明字符串,该字符串唯一标识指定客户端的流式处理会话。

语法

参数

client   _In_
类型:XGameStreamingClientId
正在查询的流式处理客户端。 sessionIdSize   _In_
类型:size_t
sessionId 缓冲区的大小。 sessionId   _Out_writes_bytes_to_(sessionIdSize, *sessionIdUsed)
类型:char*
将填充指定客户端会话 ID 的缓冲区。 sessionIdUsed   _Out_opt_
类型:size_t*
sessionId 缓冲区中返回的值的大小(以字节为单位,包括 null 终止符)。

返回值

类型:HRESULT 如果成功,则返回 S_OK;否则返回错误代码。

潜在错误

有关错误代码列表,请参阅错误代码

备注

写入 sessionId 的字符串永远不会大于 SessionIdMaxBytes,因此可以预分配。sessionId 的布局/内容可能在以后更改,因此应仅将其解释为不透明字符串。与其他客户端属性 API 一样,建议使用 XGameStreamingRegisterClientPropertiesChanged 注册 sessionId 更改的回调。

示例

要求

标头: xgamestreaming.h
库: xgameruntime.lib
支持的平台: Windows、XBOX One 系列主机和 XBOX Series 主机

另请参阅

XGameStreaming XGameStreamingRegisterClientPropertiesChanged
最后修改于 2026年8月24日