RemoveItemPreview:移除额外预览
按索引移除更新中的已有额外预览。适用于实现工坊上传和管理工具的开发者。
函数声明
bool RemoveItemPreview( UGCUpdateHandle_t handle, uint32 index );
参数
| 名称 | 类型 | 作用 |
|---|---|---|
handle |
UGCUpdateHandle_t |
输入:由 StartItemUpdate 取得、用于本次操作的更新句柄。 |
index |
uint32 |
输入:待操作的额外预览索引;对应已有预览的顺序。 |
返回与完成机制
返回 bool;官方页面未列出具体的 true 与 false 条件,调用方应检查结果并以 SDK 定义为准。
调用规则与常见错误
官方页面对这两个参数和边界没有详细说明。结合相邻的预览更新接口使用更新句柄与目标索引,并在提交前核对索引;不应假设未记录的失败原因。
相关站内接口
AddItemPreviewFile、UpdateItemPreviewFile、SubmitItemUpdate;回调、结构体及枚举。