CreateQueryUserUGCRequest:创建用户内容查询
ISteamUGC::CreateQueryUserUGCRequest 用于创建用户内容查询。本页面向 Steam 创意工坊浏览器与工具开发者,说明该调用的参数、结果以及它在查询流程中的使用条件。
函数声明
以下声明记录了当前参考页面的接口形式;不同 SDK 版本应以项目实际使用的头文件为准。通过初始化成功后的 SteamUGC() 访问该接口。
UGCQueryHandle_t CreateQueryUserUGCRequest( AccountID_t unAccountID, EUserUGCList eListType, EUGCMatchingUGCType eMatchingUGCType, EUserUGCListSortOrder eSortOrder, AppId_t nCreatorAppID, AppId_t nConsumerAppID, uint32 unPage );
参数
| 参数 | 类型 | 说明 |
|---|---|---|
unAccountID |
AccountID_t |
输入:查询目标的账户 ID。 |
eListType |
EUserUGCList |
输入:用户 UGC 列表种类。 |
eMatchingUGCType |
EUGCMatchingUGCType |
输入:待匹配的 UGC 内容类型。 |
eSortOrder |
EUserUGCListSortOrder |
输入:用户列表排序规则。 |
nCreatorAppID |
AppId_t |
输入:创建内容的应用 App ID。 |
nConsumerAppID |
AppId_t |
输入:消费内容的游戏或应用 App ID。 |
unPage |
uint32 |
输入:页码,从 1 开始。 |
返回与完成机制
成功时返回查询句柄,创建失败返回 k_UGCQueryHandleInvalid。句柄只是请求的本地标识;发送后还需等待异步查询完成,最后调用释放接口。
调用规则与注意事项
可查询用户发布、收藏或订阅的内容;账号 ID 可从 Steam ID 的 GetAccountID 取得。页码从 1 开始,每页最多 50 项。投票和订阅等部分列表仅能查询当前用户;App ID 无效、页码越界或列表无权访问时创建失败。
创建只准备查询,尚未发出网络请求。可按需要设置筛选和返回字段,随后调用 SendQueryUGCRequest;完成读取或处理失败后释放句柄。
相关站内接口
CreateQueryAllUGCRequest、SendQueryUGCRequest;数据结构与枚举可参阅 回调、结构体与枚举。
资料依据:Steamworks ISteamUGC 接口。