GetQueryUGCAdditionalPreview:读取额外预览详情

GetQueryUGCAdditionalPreview:读取额外预览详情

ISteamUGC::GetQueryUGCAdditionalPreview 用于读取额外预览详情。本页面向 Steam 创意工坊浏览器与工具开发者,说明该调用的参数、结果以及它在查询流程中的使用条件。

工坊分发与加载流程

函数声明

以下声明记录了当前参考页面的接口形式;不同 SDK 版本应以项目实际使用的头文件为准。通过初始化成功后的 SteamUGC() 访问该接口。

bool GetQueryUGCAdditionalPreview( UGCQueryHandle_t handle, uint32 index, uint32 previewIndex, char *pchURLOrVideoID, uint32 cchURLSize, char *pchOriginalFileName, uint32 cchOriginalFileNameSize, EItemPreviewType *pPreviewType );

参数

参数 类型 说明
handle UGCQueryHandle_t 输入:查询句柄,由创建查询的方法取得。
index uint32 输入:本次查询结果中的项目索引,从 0 开始,应小于完成结果的返回数量。
previewIndex uint32 输入:额外预览索引,从 0 开始,应小于预览数量。
pchURLOrVideoID char * 输出:URL 或视频 ID 的字符缓冲区。
cchURLSize uint32 输入:URL 或视频 ID 缓冲区的容量,单位为字节。
pchOriginalFileName char * 输出:原始文件名缓冲区;不接收时可传 NULL。
cchOriginalFileNameSize uint32 输入:原文件名缓冲区的容量,单位为字节。
pPreviewType EItemPreviewType * 输出:预览类型枚举变量的地址。

返回与完成机制

返回 bool;读取成功为 true,失败为 false。仅在成功时使用输出数据;失败时先检查查询结果、句柄及索引是否有效。

调用规则与注意事项

先请求额外预览并取得数量,再按索引获取 URL 或视频 ID 和类型;不需要原文件名时可传 NULL。项目或预览索引越界、查询句柄无效时返回 false。两种字符串缓冲区均需按字节提供容量。

读取前先等待 SteamUGCQueryCompleted_t 成功,检查调用结果及项目索引;在查询句柄有效期间读取并复制数据。结果使用完毕后调用 ReleaseQueryUGCRequest。

相关站内接口

SetReturnAdditionalPreviews、GetQueryUGCNumAdditionalPreviews;数据结构与枚举可参阅 回调、结构体与枚举。

站内字段参考

SteamUGCQueryCompleted_t。

资料依据:Steamworks ISteamUGC 接口。