GetQueryUGCResult:读取项目详情

GetQueryUGCResult:读取项目详情

ISteamUGC::GetQueryUGCResult 用于读取项目详情。本页面向 Steam 创意工坊浏览器与工具开发者,说明该调用的参数、结果以及它在查询流程中的使用条件。

工坊分发与加载流程

函数声明

以下声明记录了当前参考页面的接口形式;不同 SDK 版本应以项目实际使用的头文件为准。通过初始化成功后的 SteamUGC() 访问该接口。

bool GetQueryUGCResult( UGCQueryHandle_t handle, uint32 index, SteamUGCDetails_t *pDetails );

参数

参数 类型 说明
handle UGCQueryHandle_t 输入:查询句柄,由创建查询的方法取得。
index uint32 输入:本次查询结果中的项目索引,从 0 开始,应小于完成结果的返回数量。
pDetails SteamUGCDetails_t * 输出:由调用方分配的项目详情结构体。

返回与完成机制

返回 bool;读取成功为 true,失败为 false。仅在成功时使用输出数据;失败时先检查查询结果、句柄及索引是否有效。

调用规则与注意事项

查询成功后按结果索引填写 SteamUGCDetails_t。索引范围由完成结果中的 m_unNumResultsReturned 决定;句柄无效或索引越界返回 false。需要持久保存的数据应在释放句柄前复制到应用自己的存储。

读取前先等待 SteamUGCQueryCompleted_t 成功,检查调用结果及项目索引;在查询句柄有效期间读取并复制数据。结果使用完毕后调用 ReleaseQueryUGCRequest。

相关站内接口

SendQueryUGCRequest、ReleaseQueryUGCRequest;数据结构与枚举可参阅 回调、结构体与枚举。

站内字段参考

SteamUGCQueryCompleted_t。

资料依据:Steamworks ISteamUGC 接口。