GetQueryUGCContentDescriptors:读取内容描述词标记
ISteamUGC::GetQueryUGCContentDescriptors 用于读取内容描述词标记。本页面向 Steam 创意工坊浏览器与工具开发者,说明该调用的参数、结果以及它在查询流程中的使用条件。
函数声明
以下声明记录了当前参考页面的接口形式;不同 SDK 版本应以项目实际使用的头文件为准。通过初始化成功后的 SteamUGC() 访问该接口。
uint32 GetQueryUGCContentDescriptors( UGCQueryHandle_t handle, uint32 index, EUGCContentDescriptorID *pvecDescriptors, uint32 cMaxEntries );
参数
| 参数 | 类型 | 说明 |
|---|---|---|
handle |
UGCQueryHandle_t |
输入:查询句柄,由创建查询的方法取得。 |
index |
uint32 |
输入:本次查询结果中的项目索引,从 0 开始,应小于完成结果的返回数量。 |
pvecDescriptors |
EUGCContentDescriptorID * |
输出:调用方提供的内容描述词数组。 |
cMaxEntries |
uint32 |
输入:输出数组可容纳的元素个数。 |
返回与完成机制
声明为 uint32。官方页面的返回文字与声明互相矛盾;数组写入及返回值的精确语义应以所用 SDK 头文件为准,不能按布尔值推断。
调用规则与注意事项
成功查询后将内容描述词写入调用方提供的数组,容量以元素数表示。官方声明返回 uint32,文字却写 bool 并称返回编号;目前无法据此确定返回值语义,使用前应以 SDK 头文件及目标版本验证。
读取前先等待 SteamUGCQueryCompleted_t 成功,检查调用结果及项目索引;在查询句柄有效期间读取并复制数据。结果使用完毕后调用 ReleaseQueryUGCRequest。
相关站内接口
AddContentDescriptor、RemoveContentDescriptor;数据结构与枚举可参阅 回调、结构体与枚举。
站内字段参考
资料依据:Steamworks ISteamUGC 接口。