GetQueryUGCStatistic:读取项目统计值
ISteamUGC::GetQueryUGCStatistic 用于读取项目统计值。本页面向 Steam 创意工坊浏览器与工具开发者,说明该调用的参数、结果以及它在查询流程中的使用条件。
函数声明
以下声明记录了当前参考页面的接口形式;不同 SDK 版本应以项目实际使用的头文件为准。通过初始化成功后的 SteamUGC() 访问该接口。
bool GetQueryUGCStatistic( UGCQueryHandle_t handle, uint32 index, EItemStatistic eStatType, uint64 *pStatValue );
参数
| 参数 | 类型 | 说明 |
|---|---|---|
handle |
UGCQueryHandle_t |
输入:查询句柄,由创建查询的方法取得。 |
index |
uint32 |
输入:本次查询结果中的项目索引,从 0 开始,应小于完成结果的返回数量。 |
eStatType |
EItemStatistic |
输入:要读取的统计类别。 |
pStatValue |
uint64 * |
输出:统计数值变量的地址。 |
返回与完成机制
返回 bool;读取成功为 true,失败为 false。仅在成功时使用输出数据;失败时先检查查询结果、句柄及索引是否有效。
调用规则与注意事项
成功查询后按 EItemStatistic 选择订阅数、收藏数或游戏时间等统计项,并将结果写入 uint64 输出变量。句柄、项目索引或统计枚举无效时返回 false;按时间段统计时应在发送前请求相应数据。
读取前先等待 SteamUGCQueryCompleted_t 成功,检查调用结果及项目索引;在查询句柄有效期间读取并复制数据。结果使用完毕后调用 ReleaseQueryUGCRequest。
相关站内接口
SetReturnPlaytimeStats、GetQueryUGCResult;数据结构与枚举可参阅 回调、结构体与枚举。
站内字段参考
资料依据:Steamworks ISteamUGC 接口。