GetQueryUGCKeyValueTag:读取一个键值标签
ISteamUGC::GetQueryUGCKeyValueTag 用于读取一个键值标签。本页面向 Steam 创意工坊浏览器与工具开发者,说明该调用的参数、结果以及它在查询流程中的使用条件。
函数声明
以下声明记录了当前参考页面的接口形式;不同 SDK 版本应以项目实际使用的头文件为准。通过初始化成功后的 SteamUGC() 访问该接口。
bool GetQueryUGCKeyValueTag( UGCQueryHandle_t handle, uint32 index, uint32 keyValueTagIndex, char *pchKey, uint32 cchKeySize, char *pchValue, uint32 cchValueSize );
参数
| 参数 | 类型 | 说明 |
|---|---|---|
handle |
UGCQueryHandle_t |
输入:查询句柄,由创建查询的方法取得。 |
index |
uint32 |
输入:本次查询结果中的项目索引,从 0 开始,应小于完成结果的返回数量。 |
keyValueTagIndex |
uint32 |
输入:键值标签索引,从 0 开始,应小于该项目的键值标签数量。 |
pchKey |
char * |
输出:键的字符缓冲区。 |
cchKeySize |
uint32 |
输入:键缓冲区的容量,单位为字节。 |
pchValue |
char * |
输出:键值标签的值字符串缓冲区。 |
cchValueSize |
uint32 |
输入:值缓冲区的容量,单位为字节。 |
返回与完成机制
返回 bool;读取成功为 true,失败为 false。仅在成功时使用输出数据;失败时先检查查询结果、句柄及索引是否有效。
调用规则与注意事项
先启用 SetReturnKeyValueTags 并取得标签数量,再按索引提供键和值的独立输出缓冲区,容量均按字节传入。无效句柄、项目索引或键值标签索引越界返回 false。
读取前先等待 SteamUGCQueryCompleted_t 成功,检查调用结果及项目索引;在查询句柄有效期间读取并复制数据。结果使用完毕后调用 ReleaseQueryUGCRequest。
相关站内接口
SetReturnKeyValueTags、GetQueryUGCNumKeyValueTags;数据结构与枚举可参阅 回调、结构体与枚举。
站内字段参考
资料依据:Steamworks ISteamUGC 接口。