readFile

读取文本文件内容，只支持utf-8编码文本类型文件

readFile({params}, callback(ret, err))

params

sync：

  • 类型：布尔
  • 默认值：false
  • 描述：执行结果的返回方式。为false时通过callback返回，为true时直接返回。

path：

  • 类型：字符串
  • 默认值：无
  • 描述：文件路径，支持绝对路径和文件路径协议如fs://、widget://等

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true,        //操作成功状态值
  3.     data:""             //文件内容，字符串类型
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code:0,             //错误码
  3.     msg:""              //错误描述
  4. }
  6. code取值范围:
  8. 0            //没有错误
  9. 1            //找不到文件错误
  10. 2            //不可读取错误
  11. 3            //编码格式错误
  12. 4            //无效操作错误
  13. 5            //无效修改错误
  14. 6            //磁盘溢出错误
  15. 7            //文件已存在错误

示例代码

  1. //异步返回结果：
  2. api.readFile({
  3.     path: 'fs://a.txt'
  4. }, function(ret, err) {
  5.     if (ret.status) {
  6.         var data = ret.data;
  7.     } else {
  8.         alert(err.msg);
  9.     }
  10. });
  12. //同步返回结果：
  13. var data = api.readFile({
  14.     sync: true,
  15.     path: 'fs://a.txt'
  16. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本