PFSegmentsServerGetPlayersInSegmentAsync - XBOX Game Development Documentation

允许分页浏览给定细分中的所有玩家。此 API 会创建在其创建时匹配细分定义的所有玩家配置文件的快照，并在“存留总秒数”期间持续存在，每次后续使用延续令牌都会刷新其生存期。在分页过程中发生更改的配置文件将不会反映在结果中。此操作目前不支持 AB 测试细分。注意：此 API 限制为每分钟调用 30 次。如果超过此阈值，将返回错误。

语法

HRESULT PFSegmentsServerGetPlayersInSegmentAsync(  
    PFEntityHandle titleEntityHandle,  
    const PFSegmentsGetPlayersInSegmentRequest* request,  
    XAsyncBlock* async  
)  

参数

titleEntityHandle PFEntityHandle 使用 PFAuthenticationGetEntityWithSecretKeyAsync 获取的标题实体的 PFEntityHandle。 request PFSegmentsGetPlayersInSegmentRequest* 已填充的请求对象。 async XAsyncBlock*
Inout 用于异步操作的 XAsyncBlock。

返回值

类型：HRESULT 此 API 操作的结果代码。

备注

此 API 在 Win32、Linux 和 macOS 上可用。初始请求必须至少包含一个细分 ID。后续请求必须包含细分 ID 以及延续令牌。若未发送延续令牌，将会生成新的玩家细分列表。每次传入延续令牌时，都会刷新“存留总秒数”的长度。如果请求之间的时间过长，导致后续请求超出“存留总秒数”，将返回错误并终止分页。此 API 资源密集，不应在可能产生高请求量的场景中使用。每个标题一次只应向此 API 发出一个请求。对该 API 的并发请求可能会被拒绝，并返回 APIConcurrentRequestLimitExceeded 错误。另请参阅 ServerGetAllSegmentsAsync。当异步任务完成时，请调用 PFSegmentsServerGetPlayersInSegmentGetResultSize 和 PFSegmentsServerGetPlayersInSegmentGetResult 以获取结果。

要求

头文件： PFSegments.h

另请参阅

PFSegments 成员

​语法

​参数

​返回值

​备注

​要求

​另请参阅

语法

参数

返回值

备注

要求

另请参阅