GetQueryUGCNumKeyValueTags:获取键值标签数量
ISteamUGC::GetQueryUGCNumKeyValueTags 用于获取键值标签数量。本页面向 Steam 创意工坊浏览器与工具开发者,说明该调用的参数、结果以及它在查询流程中的使用条件。
函数声明
以下声明记录了当前参考页面的接口形式;不同 SDK 版本应以项目实际使用的头文件为准。通过初始化成功后的 SteamUGC() 访问该接口。
uint32 GetQueryUGCNumKeyValueTags( UGCQueryHandle_t handle, uint32 index );
参数
| 参数 | 类型 | 说明 |
|---|---|---|
handle |
UGCQueryHandle_t |
输入:查询句柄,由创建查询的方法取得。 |
index |
uint32 |
输入:本次查询结果中的项目索引,从 0 开始,应小于完成结果的返回数量。 |
返回与完成机制
声明返回 uint32;其数值含义见本页调用规则。涉及索引的读取应先确认查询成功,并区分有效的零结果与异常情形。
调用规则与注意事项
查询成功后返回指定项目的键值标签数量,接着可按索引调用 GetQueryUGCKeyValueTag。需要在发送前启用 SetReturnKeyValueTags。无效句柄或项目索引越界返回 0,因此应先验证查询结果。
读取前先等待 SteamUGCQueryCompleted_t 成功,检查调用结果及项目索引;在查询句柄有效期间读取并复制数据。结果使用完毕后调用 ReleaseQueryUGCRequest。
相关站内接口
SetReturnKeyValueTags、GetQueryUGCKeyValueTag;数据结构与枚举可参阅 回调、结构体与枚举。
站内字段参考
资料依据:Steamworks ISteamUGC 接口。