XGameStreamingGetClients

获取每个当前连接的客户端的 ID。

语法

HRESULT XGameStreamingGetClients(  
         uint32_t clientCount,  
         XGameStreamingClientId* clients,  
         uint32_t* clientsUsed  
)  

参数

clientCount _In_
类型:uint32_t

可在客户端数组中返回的最多客户端数。

clients _Out_writes_to_(clientCount,clientsUsed)
类型:XGameStreamingClientId

用于存储已连接的客户端 ID 的缓冲区。

clientsUsed _Out_
类型:uint32_t*

实际写入客户端数组的客户端数。

返回值

类型:HRESULT

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

可能的错误

错误代码 错误值 错误原因
E_GAMESTREAMING_NOT_INITIALIZED 0x89245400 XGameStreaming 运行时尚未初始化。 在调用其他 API 之前,请先调用 XGameStreamingInitialize
E_NOT_SUFFICIENT_BUFFER 0x7A clientCount 中指定的数小于当前连接的客户端数。

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

备注

用于获取当前已连接的每个流式处理客户端设备的 XGameStreamingClientId

如果游戏仅尝试确定是否有任何设备处于连接状态并且正在流式处理,请考虑使用 XGameStreamingIsStreaming

如果游戏需要在流式处理客户端连接和/或断开连接时获得通知,请考虑使用 XGameStreamingRegisterConnectionStateChanged

要求

头文件:xgamestreaming.h

库:xgameruntime.lib

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

另请参阅

XGameStreamingIsStreaming
XGameStreamingRegisterConnectionStateChanged
XGameStreamingGetClientCount
XGameStreaming