SetItemDescription:设置项目描述

SetItemDescription:设置项目描述

为项目更新提供描述文本。适用于实现工坊上传和管理工具的开发者。

工坊发布与加载流程

函数声明

bool SetItemDescription( UGCUpdateHandle_t handle, const char *pchDescription );

参数

名称 类型 作用
handle UGCUpdateHandle_t 输入:由 StartItemUpdate 取得、用于本次操作的更新句柄。
pchDescription const char * 输入:项目描述字符串。

返回与完成机制

返回 bool;true 表示设置成功,false 表示更新句柄无效。

调用规则与常见错误

必须在提交之前设置;长度受 k_cchPublishedDocumentDescriptionMax 限制,官方值 8000 字节。通过 SetItemUpdateLanguage 选择语言,默认 english;查询完整描述需启用 SetReturnLongDescription。

相关站内接口

SetItemUpdateLanguage、SetReturnLongDescription、SubmitItemUpdate;回调、结构体及枚举。

官方核对:ISteamUGC::SetItemDescription。