FileSystemManager.readFileSync
收藏我的收藏
基础库 1.15.0 开始支持本方法,这是一个同步方法。
读取本地文件内容。
前提条件 | 无 |
业务背景 | 无 |
使用限制 | 无 |
注意事项 | readFileSync 可以用于 用户目录(ttfile://user) 临时目录(ttfile://temp) 以及 包内目录(访问包内目录不需要加额外协议头) |
相关教程 | 无 |
语法
FileSystemManager.readFileSync(filePath, encoding)
参数说明
filePath
类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|
string | 是 | 要读取的文件的路径 | 1.15.0 |
encoding
类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|
string | 否 | 指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容 | 1.15.0 |
encoding 参数说明
合法值如下:
值 | 说明 | 最低支持版本 |
ascii | - | 1.15.0 |
base64 | - | 1.15.0 |
binary | - | 1.15.0 |
hex | - | 1.15.0 |
ucs2 | 以小端序读取 | 1.15.0 |
ucs-2 | 以小端序读取 | 1.15.0 |
utf16le | 以小端序读取 | 1.15.0 |
utf-16le | 以小端序读取 | 1.15.0 |
utf-8 | - | 1.15.0 |
utf8 | - | 1.15.0 |
latin1 | - | 1.15.0 |
返回值
类型 | 说明 | 最低支持版本 |
---|---|---|
string | 文件内容, 根据 encoding 设置不同返回 string 或 ArrayBuffer 类型 | 1.15.0 |
错误码
errNo | errMsg | 说明 | 最低支持版本 |
---|---|---|---|
20001 | invalid param | 参数错误 | 1.15.0 |
21101 | permission denied, $apiName $filePath | 1.15.0 | |
21103 | no such file or directory, $apiName $filePath | 1.15.0 | |
21102 | operation not permitted, $apiName $filePath | 1.15.0 | |
10401 | error stack | 小游戏框架内部错误,有需要请创建工单咨询 | 1.15.0 |
20000 | params $paramName is required | 1.15.0 | |
20000 | params $paramName type is not $paramType type | 1.15.0 | |
20000 | $paramName is invalid | 1.15.0 | |
20000 | internal error | 小游戏框架内部错误,有需要请创建工单咨询 | 1.15.0 |
21103 | no such file or directory, $apiName $filePath | 小游戏框架内部错误,有需要请创建工单咨询 | 1.15.0 |
代码示例
const fileSystemManager = tt.getFileSystemManager(); tt.chooseImage({ success(res) { try { const data = fileSystemManager.readFileSync(res.tempFilePaths[0]); console.log("调用成功", data); } catch (err) { console.log("调用失败", err); } }, });