SetItemPreview:设置主要预览图片
为项目更新设置展示用的主预览图片。适用于实现工坊上传和管理工具的开发者。
函数声明
bool SetItemPreview( UGCUpdateHandle_t handle, const char *pszPreviewFile );
参数
| 名称 | 类型 | 作用 |
|---|---|---|
handle |
UGCUpdateHandle_t |
输入:由 StartItemUpdate 取得、用于本次操作的更新句柄。 |
pszPreviewFile |
const char * |
输入:本地预览图片文件的绝对路径。 |
返回与完成机制
返回 bool;true 表示设置成功,false 表示更新句柄无效。最终上传结果通过 SubmitItemUpdateResult_t 检查。
调用规则与常见错误
提交前传本地图片绝对路径;格式应可由网页和应用显示,推荐 JPG、PNG 或 GIF。预览图存储在用户 Steam 云中,应用需配置云字节和文件数量配额。
相关站内接口
StartItemUpdate、SubmitItemUpdate、AddItemPreviewFile;回调、结构体及枚举。