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 |
错误码
| errorCode | errMsg | errorType | 说明 | 最低支持版本 |
|---|---|---|---|---|
| 108301 | permission denied, %s %s | D | 没有权限 请查看filePath参数是否正确 | 1.15.0 |
| 108303 | no such file or directory, %s %s-> %s | D | 目标路径或源文件不存在 请查看filePath参数是否正确 | 1.15.0 |
| 161799 | params filePath is required | D | filePath是必传值 请查看filePath参数是否正确 | 1.15.0 |
扫码体验
请使用字节宿主APP扫码
