SetReturnAdditionalPreviews:请求额外预览信息

SetReturnAdditionalPreviews:请求额外预览信息

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

工坊分发与加载流程

函数声明

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

bool SetReturnAdditionalPreviews( UGCQueryHandle_t handle, bool bReturnAdditionalPreviews );

参数

参数 类型 说明
handle UGCQueryHandle_t 输入:查询句柄,由创建查询的方法取得。
bReturnAdditionalPreviews bool 输入:true 开启该返回选项;false 关闭。

返回与完成机制

返回 bool;设置成功为 true,失败为 false。设置成功只说明当前调用被接受,查询是否成功仍须检查异步完成结果。

调用规则与注意事项

开启后可在查询成功时读取额外图片或视频预览。先调用 GetQueryUGCNumAdditionalPreviews 得到数量,再通过 GetQueryUGCAdditionalPreview 按索引读取。该选项在发送前设置。

这项配置作用于尚未发送的查询。先检查返回值,再调用 SendQueryUGCRequest;完成后读取所需数据并调用 ReleaseQueryUGCRequest。不要把设置成功当作最终查询成功。

相关站内接口

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

资料依据:Steamworks ISteamUGC 接口。