普通小游戏开发
API
开放能力
数据分析
视频拍摄器
多端支持

FileSystemManager.readFile

基础库 1.15.0 开始支持本方法。

读取本地文件内容。

语法

FileSystemManager.readFile(options)

参数说明

options

options 为 object 类型,属性描述如下:

属性名类型默认值必填说明最低支持版本
filePathstring要读取的文件的路径1.15.0
encodingstring指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容1.15.0
successFunction接口调用成功的回调函数1.15.0
failFunction接口调用失败的回调函数1.15.0
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)1.15.0

encoding 的合法值

说明
ascii
base64
binary
hex
ucs2/ucs-2/utf16le/utf-16le以小端序读取
utf-8/utf8
latin1

回调成功

回调参数为 object 类型,属性如下:

属性类型说明最低支持版本
datastring \ ArrayBuffer数据

回调失败

回调参数为 object 类型,属性如下:

属性类型说明最低支持版本
errNonumber错误码1.99.0
errMsgstring"readFile:fail " + 详细错误信息1.15.0

错误码说明:

errNoerrMsg说明最低支持版本
20000readFile:fail filePath is invalidfilePath 参数错误1.99.0
20001readFile:fail param should be xxx, but got xxx参数校验错误1.99.0
21101readFile:fail permission denied, readFile {filePath_value}无操作权限(filePath 路径不可读)1.99.0
21102readFile:fail operation not permitted, readFile {filePath_value}类型不正确(不是文件路径)1.99.0
21103readFile:fail no such file or directory, readFile {filePath_value}filePath 文件不存在1.99.0

代码示例

开发者工具中预览

const fileSystemManager = tt.getFileSystemManager();

tt.chooseImage({
  success(res) {
    readFile(res.tempFilePaths[0]);
  },
});

function readFile(filePath) {
  fileSystemManager.readFile({
    filePath,
    success(res) {
      // 输出读取的文件内容
      console.log(res.data);
    },
    fail(res) {
      console.log("调用失败", res.errMsg);
    },
  });
}

Bug & Tip

  • Tip: readFile 可以用于 用户目录(ttfile://user) 临时目录(ttfile://temp) 以及 包内目录(访问包内目录不需要加额外协议头)
点击纠错
评价此篇文档