GetQueryUGCChildren:读取子项目 ID
ISteamUGC::GetQueryUGCChildren 用于读取子项目 ID。本页面向 Steam 创意工坊浏览器与工具开发者,说明该调用的参数、结果以及它在查询流程中的使用条件。
函数声明
以下声明记录了当前参考页面的接口形式;不同 SDK 版本应以项目实际使用的头文件为准。通过初始化成功后的 SteamUGC() 访问该接口。
bool GetQueryUGCChildren( UGCQueryHandle_t handle, uint32 index, PublishedFileId_t*pvecPublishedFileID, uint32 cMaxEntries );
参数
| 参数 | 类型 | 说明 |
|---|---|---|
handle |
UGCQueryHandle_t |
输入:查询句柄,由创建查询的方法取得。 |
index |
uint32 |
输入:本次查询结果中的项目索引,从 0 开始,应小于完成结果的返回数量。 |
pvecPublishedFileID |
PublishedFileId_t * |
输出:调用方分配的子项目 ID 数组。 |
cMaxEntries |
uint32 |
输入:输出数组可容纳的元素个数。 |
返回与完成机制
返回 bool;读取成功为 true,失败为 false。仅在成功时使用输出数据;失败时先检查查询结果、句柄及索引是否有效。
调用规则与注意事项
在请求中启用 SetReturnChildren,查询成功后读取详情中的 m_unNumChildren,并按元素数量分配 ID 数组。子项可能是合集成员,也可能代表普通项目的依赖;句柄无效或项目索引越界会失败。
读取前先等待 SteamUGCQueryCompleted_t 成功,检查调用结果及项目索引;在查询句柄有效期间读取并复制数据。结果使用完毕后调用 ReleaseQueryUGCRequest。
相关站内接口
SetReturnChildren、GetQueryUGCResult;数据结构与枚举可参阅 回调、结构体与枚举。
站内字段参考
资料依据:Steamworks ISteamUGC 接口。