GetSupportedGameVersionData:读取项目版本的分支范围

GetSupportedGameVersionData:读取项目版本的分支范围

ISteamUGC::GetSupportedGameVersionData 用于读取项目版本的分支范围。本页面向 Steam 创意工坊浏览器与工具开发者,说明该调用的参数、结果以及它在查询流程中的使用条件。

工坊分发与加载流程

函数声明

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

bool GetSupportedGameVersionData( UGCQueryHandle_t handle, uint32 index, uint32 versionIndex, STEAM_OUT_STRING_COUNT( cchGameBranchSize ) char *pchGameBranchMin, STEAM_OUT_STRING_COUNT( cchGameBranchSize ) char *pchGameBranchMax, uint32 cchGameBranchSize );

参数

参数 类型 说明
handle UGCQueryHandle_t 输入:查询句柄,由创建查询的方法取得。
index uint32 输入:本次查询结果中的项目索引,从 0 开始,应小于完成结果的返回数量。
versionIndex uint32 输入:项目版本索引,从 0 开始,应小于版本数量。
pchGameBranchMin char * 输出:最低支持分支名的字符缓冲区。
pchGameBranchMax char * 输出:最高支持分支名的字符缓冲区。
cchGameBranchSize uint32 输入:两个分支名缓冲区各自的容量,单位为字节。

返回与完成机制

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

调用规则与注意事项

先取得版本数量,再用 versionIndex 选择版本。最小分支为空时表示向较旧分支延伸,最大分支为空时表示向较新分支延伸,两端都为空表示适用全部分支;分支顺序由开发者在 Steamworks 中维护。返回 true 代表给定版本存在。

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

相关站内接口

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

站内字段参考

SteamUGCQueryCompleted_t。

资料依据:Steamworks ISteamUGC 接口。