抖音开放平台Logo
控制台

FileSystemManager.readFileSync
收藏
我的收藏

基础库 1.15.0 开始支持本方法，这是一个同步方法。

读取本地文件内容。

前提条件无
业务背景无
使用限制无
注意事项
readFileSync 可以用于 用户目录(ttfile://user) 临时目录(ttfile://temp) 以及 包内目录(访问包内目录不需要加额外协议头)。
支持沙盒
否
相关教程无

语法

FileSystemManager.readFileSync(filePath, encoding, position, length)

参数说明

filePath

类型默认值必填说明最低支持版本
string是
要读取的文件的路径
1.15.0

encoding

类型默认值必填说明最低支持版本
string否
字符编码
1.15.0

position

类型默认值必填说明最低支持版本
number否
从文件指定位置开始读，如果不指定，则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围：[0, fileLength - 1]。单位：byte
2.60.0

length

类型默认值必填说明最低支持版本
number否
指定文件的长度，如果不指定，则读到文件末尾。有效范围：[1, fileLength]。单位：byte
2.60.0

返回值

类型说明最低支持版本
string | arraybuffer
文件内容, 根据 encoding 设置不同返回 string 或 ArrayBuffer 类型
1.15.0

错误码

errNoerrMsg说明最低支持版本
20000readFileSync:fail filePath is invalid
filePath 参数错误
1.99.0
20000readFile:fail the value of "position" is out of range
position 参数超出文件范围
2.60.0
20000readFile:fail the value of "length" is out of range
length 参数超出文件范围
1.99.0
21101readFileSync:fail permission denied, readFileSync %s
无操作权限(filePath 路径不可读)
1.99.0
21102readFileSync:fail operation not permitted, readFileSync %s
类型不正确(不是文件路径)
1.99.0
21103readFileSync:fail no such file or directory, readFileSync %s
filePath 文件不存在
1.99.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

const fileSystemManager = tt.getFileSystemManager()

tt.chooseImage({
  success(res) {
    try {
      const data = fileSystemManager.readFileSync(
        res.tempFilePaths[0],
        "utf8",
        0,
        10
      )
      console.log("调用成功", data)
    } catch (err) {
      console.log("调用失败", err)
    }
  },
})