文件函数

文件操作

8 个函数

读取文件

File.read(path: string): string

读取指定文件的全部文本内容。

参数1 项
序号名称类型参数说明
1 path 要读取的文件绝对路径。示例:/sdcard/测试.txt
返回值至少接收一个返回值
序号名称类型返回说明
1 content 文件文本;空文件或读取失败时为空字符。
  • 文件内容:读取成功
  • "":空文件或读取失败

写入文件

File.write(path: string, content: string, mode: integer): integer

把文本覆盖写入文件,或追加到文件末尾。

参数3 项
序号名称类型参数说明
1 path 要写入的文件绝对路径。示例:/sdcard/测试.txt
2 content 要写入的文本内容,例如 "测试内容" 或字符变量。
3 mode 写入方式:0 覆盖,1 追加。
返回值返回值可以不接收
序号名称类型返回说明
1 status 操作状态。
  • 1:操作成功
  • 0:操作失败

删除文件

File.remove(path: string): integer

删除文件或递归删除文件夹。

参数1 项
序号名称类型参数说明
1 path 要删除的文件或目录绝对路径。示例:/sdcard/测试.txt
返回值返回值可以不接收
序号名称类型返回说明
1 status 操作状态。
  • 1:操作成功
  • 0:操作失败

复制文件

File.copy(source: string, target: string, conflictMode: integer): integer

复制文件或文件夹到目标路径。

参数3 项
序号名称类型参数说明
1 source 源文件或目录绝对路径。示例:/sdcard/测试.txt
2 target 目标绝对路径。示例:/sdcard/备份/测试.txt
3 conflictMode 目标已存在时:0 操作失败,1 替换目标。
返回值返回值可以不接收
序号名称类型返回说明
1 status 操作状态。
  • 1:操作成功
  • 0:操作失败

移动文件

File.move(source: string, target: string, conflictMode: integer): integer

移动文件或文件夹到目标路径。

参数3 项
序号名称类型参数说明
1 source 源文件或目录绝对路径。示例:/sdcard/测试.txt
2 target 移动后的绝对路径。示例:/sdcard/归档/测试.txt
3 conflictMode 目标已存在时:0 操作失败,1 替换目标。
返回值返回值可以不接收
序号名称类型返回说明
1 status 操作状态。
  • 1:操作成功
  • 0:操作失败

重命名

File.rename(source: string, target: string): integer

重命名文件或文件夹;目标已存在时失败。

参数2 项
序号名称类型参数说明
1 source 原文件或目录绝对路径。示例:/sdcard/测试.txt
2 target 包含新名称的绝对路径。示例:/sdcard/新名称.txt
返回值返回值可以不接收
序号名称类型返回说明
1 status 操作状态。
  • 1:操作成功
  • 0:操作失败

文件转Base64

File.toBase64(文件路径: string): string

读取任意文件并转换为标准 Base64 字符串。

参数1 项
序号名称类型参数说明
1 文件路径 要转换的文件绝对路径。示例:/sdcard/测试.txt
返回值至少接收一个返回值
序号名称类型返回说明
1 Base64字符 不带换行的 Base64 内容;空文件或读取失败时为空字符。
  • Base64字符:转换成功
  • "":空文件或读取失败

Base64转文件

File.fromBase64(Base64字符: string, 保存路径: string): integer

把标准 Base64 内容还原并保存为文件。

参数2 项
序号名称类型参数说明
1 Base64字符 要还原的标准 Base64 内容或字符变量。
2 保存路径 还原文件的绝对路径。示例:/sdcard/测试.txt
返回值返回值可以不接收
序号名称类型返回说明
1 status 操作状态。
  • 1:操作成功
  • 0:操作失败