CreateQueryAllUGCRequest:创建全局内容查询
ISteamUGC::CreateQueryAllUGCRequest 用于创建全局内容查询。本页面向 Steam 创意工坊浏览器与工具开发者,说明该调用的参数、结果以及它在查询流程中的使用条件。
函数声明
以下声明记录了当前参考页面的接口形式;不同 SDK 版本应以项目实际使用的头文件为准。通过初始化成功后的 SteamUGC() 访问该接口。
UGCQueryHandle_t CreateQueryAllUGCRequest( EUGCQuery eQueryType, EUGCMatchingUGCType eMatchingeMatchingUGCTypeFileType, AppId_t nCreatorAppID, AppId_t nConsumerAppID, uint32 unPage );
参数
| 参数 | 类型 | 说明 |
|---|---|---|
eQueryType |
EUGCQuery |
输入:全局查询的排序及筛选类型。 |
eMatchingeMatchingUGCTypeFileType |
EUGCMatchingUGCType |
输入:待匹配的 UGC 内容类型;参数名以目标 SDK 头文件为准。 |
nCreatorAppID |
AppId_t |
输入:创建内容的应用 App ID。 |
nConsumerAppID |
AppId_t |
输入:消费内容的游戏或应用 App ID。 |
unPage |
uint32 |
输入:页码,从 1 开始。 |
返回与完成机制
成功时返回查询句柄,创建失败返回 k_UGCQueryHandleInvalid。句柄只是请求的本地标识;发送后还需等待异步查询完成,最后调用释放接口。
调用规则与注意事项
按排序规则和内容类型检索应用的 UGC。页码从 1 开始,每页最多 50 项;创建者应用与消费应用可能不同,两个 App ID 至少要有一个有效,且其中一个应对应运行中的应用。无效 App ID、页码小于 1 或内部错误会导致无效句柄。
创建只准备查询,尚未发出网络请求。可按需要设置筛选和返回字段,随后调用 SendQueryUGCRequest;完成读取或处理失败后释放句柄。
相关站内接口
CreateQueryUserUGCRequest、SendQueryUGCRequest;数据结构与枚举可参阅 回调、结构体与枚举。
资料依据:Steamworks ISteamUGC 接口。