harmony 鸿蒙@ohos.fileio (文件管理)

2022-08-09
浏览 (773)

@ohos.fileio (文件管理)

该模块提供文件存储管理能力，包括文件基本管理、文件目录管理、文件信息统计、文件流式读写等常用功能。

说明： - 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - 本模块从API version 9开始废弃，建议使用@ohos.file.fs替代。

导入模块

import fileio from '@ohos.fileio';

使用说明

使用该功能模块对文件/目录进行操作前，需要先获取其应用沙箱路径，获取方式及其接口用法请参考：

Stage模型

  import UIAbility from '@ohos.app.ability.UIAbility';
  import window from '@ohos.window';

  export default class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage: window.WindowStage) {
      let context = this.context;
      let pathDir = context.filesDir;
    }
  }

Stage模型context的具体获取方法参见Stage模型。

FA模型

  import featureAbility from '@ohos.ability.featureAbility';

  let context = featureAbility.getContext();
  context.getFilesDir().then((data) => {
    let pathDir = data;
  })

FA模型context的具体获取方法参见FA模型。

fileio.stat

stat(path: string): Promise<Stat>

获取文件信息，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.stat替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待获取文件的应用沙箱路径。

返回值：

类型	说明
Promise<Stat>	Promise对象。返回文件的具体信息。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "test.txt";
  fileio.stat(filePath).then((stat: fileio.Stat) => {
    console.info("getFileInfo succeed, the size of file is " + stat.size);
  }).catch((err: BusinessError) => {
    console.info("getFileInfo failed with error:" + err);
  });

fileio.stat

stat(path: string, callback: AsyncCallback<Stat>): void

获取文件信息，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.stat替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待获取文件的应用沙箱路径。
callback	AsyncCallback<Stat>	是	异步获取文件的信息之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  fileio.stat(pathDir, (err: BusinessError, stat: fileio.Stat) => {
    // example code in Stat
  });

fileio.statSync

statSync(path: string): Stat

以同步方法获取文件的信息。

说明：

从API version 9开始废弃，请使用fs.statSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待获取文件的应用沙箱路径。

返回值：

类型	说明
Stat	表示文件的具体信息。

示例：

  let stat = fileio.statSync(pathDir);
  // example code in Stat

fileio.opendir

opendir(path: string): Promise<Dir>

打开文件目录，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.listFile替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待打开文件目录的应用沙箱路径。

返回值：

类型	说明
Promise<Dir>	Promise对象。返回Dir对象。

示例：

  import { BusinessError } from '@ohos.base';
  let dirPath = pathDir + "/testDir";
  fileio.opendir(dirPath).then((dir: fileio.Dir) => {
    console.info("opendir succeed");
  }).catch((err: BusinessError) => {
    console.info("opendir failed with error:" + err);
  });

fileio.opendir

opendir(path: string, callback: AsyncCallback<Dir>): void

打开文件目录，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.listFile替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待打开文件目录的应用沙箱路径。
callback	AsyncCallback<Dir>	是	异步打开文件目录之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  fileio.opendir(pathDir, (err: BusinessError, dir: fileio.Dir) => {
    // example code in Dir struct
    // use read/readSync/close
  });

fileio.opendirSync

opendirSync(path: string): Dir

以同步方法打开文件目录。

说明：

从API version 9开始废弃，请使用fs.listFileSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待打开文件目录的应用沙箱路径。

返回值：

类型	说明
Dir	返回Dir对象。

示例：

  let dir = fileio.opendirSync(pathDir);
  // example code in Dir struct
  // use read/readSync/close

fileio.access

access(path: string, mode?: number): Promise<void>

检查当前进程是否可访问某文件，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.access替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待访问文件的应用沙箱路径。
mode	number	否	访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。确认当前进程是否具有对应权限： - 0：确认文件是否存在。 - 1：确认当前进程是否具有可执行权限。 - 2：确认当前进程是否具有写权限。 - 4：确认当前进程是否具有读权限。

返回值：

类型	说明
Promise<void>	Promise对象。无返回值。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  fileio.access(filePath).then(() => {
    console.info("access succeed");
  }).catch((err: BusinessError) => {
    console.info("access failed with error:" + err);
  });

fileio.access

access(path: string, mode?: number, callback: AsyncCallback<void>): void

检查当前进程是否可访问某文件，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.access替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待访问文件的应用沙箱路径。
mode	number	否	访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。确认当前进程是否具有对应权限： - 0：确认文件是否存在。 - 1：确认当前进程是否具有可执行权限。 - 2：确认当前进程是否具有写权限。 - 4：确认当前进程是否具有读权限。
callback	AsyncCallback<void>	是	异步检查当前进程是否可访问某文件之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  fileio.access(filePath, (err: BusinessError) => {
    // do something
  });

fileio.accessSync

accessSync(path: string, mode?: number): void

以同步方法检查当前进程是否可访问某文件。

说明：

从API version 9开始废弃，请使用fs.accessSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待访问文件的应用沙箱路径。
mode	number	否	访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。确认当前进程是否具有对应权限： - 0：确认文件是否存在。 - 1：确认当前进程是否具有可执行权限。 - 2：确认当前进程是否具有写权限。 - 4：确认当前进程是否具有读权限。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  try {
    fileio.accessSync(filePath);
  } catch(err: unknown) {
    console.info("accessSync failed with error:" + err);
  }

fileio.close⁷⁺

close(fd: number): Promise<void>

关闭文件，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.close替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待关闭文件的文件描述符。

返回值：

类型	说明
Promise<void>	Promise对象。无返回值。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  fileio.close(fd).then(() => {
    console.info("close file succeed");
  }).catch((err: BusinessError) => {
    console.info("close file failed with error:" + err);
  });

fileio.close⁷⁺

close(fd: number, callback: AsyncCallback<void>): void

关闭文件，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.close替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待关闭文件的文件描述符。
callback	AsyncCallback<void>	是	异步关闭文件之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  fileio.close(fd, (err: BusinessError) => {
    // do something
  });

fileio.closeSync

closeSync(fd: number): void

以同步方法关闭文件。

说明：

从API version 9开始废弃，请使用fs.closeSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待关闭文件的文件描述符。

示例：

  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  fileio.closeSync(fd);

fileio.copyFile

copyFile(src: string|number, dest: string|number, mode?: number): Promise<void>

复制文件，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.copyFile替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
src	string\|number	是	待复制文件的路径或待复制文件的描述符。
dest	string\|number	是	目标文件路径或目标文件描述符。
mode	number	否	mode提供覆盖文件的选项，当前仅支持0，且默认为0。 0：完全覆盖目标文件，未覆盖部分将被裁切掉。

返回值：

类型	说明
Promise<void>	Promise对象。无返回值。

示例：

  import { BusinessError } from '@ohos.base';
  let srcPath = pathDir + "srcDir/test.txt";
  let dstPath = pathDir + "dstDir/test.txt";
  fileio.copyFile(srcPath, dstPath).then(() => {
    console.info("copyFile succeed");
  }).catch((err: BusinessError) => {
    console.info("copyFile failed with error:" + err);
  });

fileio.copyFile

copyFile(src: string|number, dest: string|number, mode: number, callback: AsyncCallback<void>): void

复制文件，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.copyFile替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
src	string\|number	是	待复制文件的路径或待复制文件的描述符。
dest	string\|number	是	目标文件路径或目标文件描述符。
mode	number	否	mode提供覆盖文件的选项，当前仅支持0，且默认为0。 0：完全覆盖目标文件，未覆盖部分将被裁切掉。
callback	AsyncCallback<void>	是	异步复制文件之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let srcPath = pathDir + "srcDir/test.txt";
  let dstPath = pathDir + "dstDir/test.txt";
  fileio.copyFile(srcPath, dstPath, (err: BusinessError) => {
    // do something
  });

fileio.copyFileSync

copyFileSync(src: string|number, dest: string|number, mode?: number): void

以同步方法复制文件。

说明：

从API version 9开始废弃，请使用fs.copyFileSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
src	string\|number	是	待复制文件的路径或待复制文件的描述符。
dest	string\|number	是	目标文件路径或目标文件描述符。
mode	number	否	mode提供覆盖文件的选项，当前仅支持0，且默认为0。 0：完全覆盖目标文件，未覆盖部分将被裁切掉。

示例：

  let srcPath = pathDir + "srcDir/test.txt";
  let dstPath = pathDir + "dstDir/test.txt";
  fileio.copyFileSync(srcPath, dstPath);

fileio.mkdir

mkdir(path: string, mode?: number): Promise<void>

创建目录，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.mkdir替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待创建目录的应用沙箱路径。
mode	number	否	创建目录的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o775。 - 0o775：所有者具有读、写及可执行权限，其余用户具有读及可执行权限。 - 0o700：所有者具有读、写及可执行权限。 - 0o400：所有者具有读权限。 - 0o200：所有者具有写权限。 - 0o100：所有者具有可执行权限。 - 0o070：所有用户组具有读、写及可执行权限。 - 0o040：所有用户组具有读权限。 - 0o020：所有用户组具有写权限。 - 0o010：所有用户组具有可执行权限。 - 0o007：其余用户具有读、写及可执行权限。 - 0o004：其余用户具有读权限。 - 0o002：其余用户具有写权限。 - 0o001：其余用户具有可执行权限。

返回值：

类型	说明
Promise<void>	Promise对象。无返回值。

示例：

  import { BusinessError } from '@ohos.base';
  let dirPath = pathDir + '/testDir';
  fileio.mkdir(dirPath).then(() => {
    console.info("mkdir succeed");
  }).catch((error: BusinessError) => {
    console.info("mkdir failed with error:" + error);
  });

fileio.mkdir

mkdir(path: string, mode: number, callback: AsyncCallback<void>): void

创建目录，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.mkdir替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待创建目录的应用沙箱路径。
mode	number	否	创建目录的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o775。 - 0o775：所有者具有读、写及可执行权限，其余用户具有读及可执行权限。 - 0o700：所有者具有读、写及可执行权限。 - 0o400：所有者具有读权限。 - 0o200：所有者具有写权限。 - 0o100：所有者具有可执行权限。 - 0o070：所有用户组具有读、写及可执行权限。 - 0o040：所有用户组具有读权限。 - 0o020：所有用户组具有写权限。 - 0o010：所有用户组具有可执行权限。 - 0o007：其余用户具有读、写及可执行权限。 - 0o004：其余用户具有读权限。 - 0o002：其余用户具有写权限。 - 0o001：其余用户具有可执行权限。
callback	AsyncCallback<void>	是	异步创建目录操作完成之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let dirPath = pathDir + '/testDir';
  fileio.mkdir(dirPath, (err: BusinessError) => {
    console.info("mkdir succeed");
  });

fileio.mkdirSync

mkdirSync(path: string, mode?: number): void

以同步方法创建目录。

说明：

从API version 9开始废弃，请使用fs.mkdirSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待创建目录的应用沙箱路径。
mode	number	否	创建目录的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o775。 - 0o775：所有者具有读、写及可执行权限，其余用户具有读及可执行权限。 - 0o700：所有者具有读、写及可执行权限。 - 0o400：所有者具有读权限。 - 0o200：所有者具有写权限。 - 0o100：所有者具有可执行权限。 - 0o070：所有用户组具有读、写及可执行权限。 - 0o040：所有用户组具有读权限。 - 0o020：所有用户组具有写权限。 - 0o010：所有用户组具有可执行权限。 - 0o007：其余用户具有读、写及可执行权限。 - 0o004：其余用户具有读权限。 - 0o002：其余用户具有写权限。 - 0o001：其余用户具有可执行权限。

示例：

  let dirPath = pathDir + '/testDir';
  fileio.mkdirSync(dirPath);

fileio.open⁷⁺

open(path: string, flags?: number, mode?: number): Promise<number>

打开文件，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.open替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待打开文件的应用沙箱路径。
flags	number	否	打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开： - 0o0：只读打开。 - 0o1：只写打开。 - 0o2：读写打开。同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项： - 0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数 mode。 - 0o200：如果追加了0o100选项，且文件已经存在，则出错。 - 0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。 - 0o2000：以追加方式打开，后续写将追加到文件末尾。 - 0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。 - 0o200000：如果path不指向目录，则出错。 - 0o400000：如果path指向符号链接，则出错。 - 0o4010000：以同步IO的方式打开文件。
mode	number	否	若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o660。 - 0o660：所有者具有读、写权限，所有用户组具有读、写权限。 - 0o700：所有者具有读、写及可执行权限。 - 0o400：所有者具有读权限。 - 0o200：所有者具有写权限。 - 0o100：所有者具有可执行权限。 - 0o070：所有用户组具有读、写及可执行权限。 - 0o040：所有用户组具有读权限。 - 0o020：所有用户组具有写权限。 - 0o010：所有用户组具有可执行权限。 - 0o007：其余用户具有读、写及可执行权限。 - 0o004：其余用户具有读权限。 - 0o002：其余用户具有写权限。 - 0o001：其余用户具有可执行权限。

返回值：

类型	说明
Promise<number>	Promise对象。返回打开文件的文件描述符。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  fileio.open(filePath, 0o1, 0o0200).then((number: number) => {
    console.info("open file succeed");
  }).catch((err: BusinessError) => {
    console.info("open file failed with error:" + err);
  });

fileio.open⁷⁺

open(path: string, flags: number, mode: number, callback: AsyncCallback<number>): void

打开文件，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.open替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待打开文件的应用沙箱路径。
flags	number	否	打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开： - 0o0：只读打开。 - 0o1：只写打开。 - 0o2：读写打开。同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项： - 0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数 mode。 - 0o200：如果追加了0o100选项，且文件已经存在，则出错。 - 0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。 - 0o2000：以追加方式打开，后续写将追加到文件末尾。 - 0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。 - 0o200000：如果path不指向目录，则出错。 - 0o400000：如果path指向符号链接，则出错。 - 0o4010000：以同步IO的方式打开文件。
mode	number	否	若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o660。 - 0o660：所有者具有读、写权限，所有用户组具有读、写权限。 - 0o700：所有者具有读、写及可执行权限。 - 0o400：所有者具有读权限。 - 0o200：所有者具有写权限。 - 0o100：所有者具有可执行权限。 - 0o070：所有用户组具有读、写及可执行权限。 - 0o040：所有用户组具有读权限。 - 0o020：所有用户组具有写权限。 - 0o010：所有用户组具有可执行权限。 - 0o007：其余用户具有读、写及可执行权限。 - 0o004：其余用户具有读权限。 - 0o002：其余用户具有写权限。 - 0o001：其余用户具有可执行权限。
callback	AsyncCallback<number>	是	异步打开文件之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  fileio.open(filePath, 0, (err: BusinessError, fd: number) => {
    // do something
  });

fileio.openSync

openSync(path: string, flags?: number, mode?: number): number

以同步方法打开文件。

说明：

从API version 9开始废弃，请使用fs.openSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待打开文件的应用沙箱路径。
flags	number	否	打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开： - 0o0：只读打开。 - 0o1：只写打开。 - 0o2：读写打开。同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项： - 0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数 mode。 - 0o200：如果追加了0o100选项，且文件已经存在，则出错。 - 0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。 - 0o2000：以追加方式打开，后续写将追加到文件末尾。 - 0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。 - 0o200000：如果path不指向目录，则出错。 - 0o400000：如果path指向符号链接，则出错。 - 0o4010000：以同步IO的方式打开文件。
mode	number	否	若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o660。 - 0o660：所有者具有读、写权限，所有用户组具有读、写权限。 - 0o640：所有者具有读、写权限，所有用户组具有读权限。 - 0o700：所有者具有读、写及可执行权限。 - 0o400：所有者具有读权限。 - 0o200：所有者具有写权限。 - 0o100：所有者具有可执行权限。 - 0o070：所有用户组具有读、写及可执行权限。 - 0o040：所有用户组具有读权限。 - 0o020：所有用户组具有写权限。 - 0o010：所有用户组具有可执行权限。 - 0o007：其余用户具有读、写及可执行权限。 - 0o004：其余用户具有读权限。 - 0o002：其余用户具有写权限。 - 0o001：其余用户具有可执行权限。创建出的文件权限受umask影响，umask随进程启动确定，其修改当前不开放。

返回值：

类型	说明
number	打开文件的文件描述符。

示例：

  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath, 0o102, 0o640);

  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath, 0o102, 0o666);
  fileio.writeSync(fd, 'hello world');
  let fd1 = fileio.openSync(filePath, 0o2002);
  fileio.writeSync(fd1, 'hello world');
  class Option {
    offset: number = 0;
    length: number = 4096;
    position: number = 0;
  }
  let option = new Option();
  option.position = 0;
  let buf = new ArrayBuffer(4096)
  let num = fileio.readSync(fd1, buf, option);
  console.info("num == " + num);

fileio.read

read(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: number; position?: number; }): Promise<ReadOut>

从文件读取数据，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.read替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待读取文件的文件描述符。
buffer	ArrayBuffer	是	用于保存读取到的文件数据的缓冲区。
options	Object	否	支持如下选项： - offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。 - length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。 - position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。约束：offset+length<=buffer.size。

返回值：

类型	说明
Promise<ReadOut>	Promise对象。返回读取的结果。

示例：

  import { BusinessError } from '@ohos.base';
  import buffer from '@ohos.buffer';
  import { ReadOut } from '@ohos.fileio';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath, 0o2);
  let arrayBuffer = new ArrayBuffer(4096);
  fileio.read(fd, arrayBuffer).then((readResult: ReadOut) => {
    console.info("read file data succeed");
    let buf = buffer.from(arrayBuffer, 0, readResult.bytesRead);
    console.log(`The content of file: ${buf.toString()}`);
  }).catch((err: BusinessError) => {
    console.info("read file data failed with error:" + err);
  });

fileio.read

read(fd: number, buffer: ArrayBuffer, options: { offset?: number; length?: number; position?: number; }, callback: AsyncCallback<ReadOut>): void

从文件读取数据，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.read替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待读取文件的文件描述符。
buffer	ArrayBuffer	是	用于保存读取到的文件数据的缓冲区。
options	Object	否	支持如下选项： - offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。 - length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。 - position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。约束：offset+length<=buffer.size。
callback	AsyncCallback<ReadOut>	是	异步读取数据之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  import buffer from '@ohos.buffer';
  import { ReadOut } from '@ohos.fileio';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath, 0o2);
  let arrayBuffer = new ArrayBuffer(4096);
  fileio.read(fd, arrayBuffer, (err: BusinessError, readResult: ReadOut) => {
    if (readLen) {
      console.info("read file data succeed");
      let buf = buffer.from(arrayBuffer, 0, readResult.bytesRead);
      console.info(`The content of file: ${buf.toString()}`);
    }
  });

fileio.readSync

readSync(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: number; position?: number; }): number

以同步方法从文件读取数据。

说明：

从API version 9开始废弃，请使用fs.readSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待读取文件的文件描述符。
buffer	ArrayBuffer	是	用于保存读取到的文件数据的缓冲区。
options	Object	否	支持如下选项： - offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。 - length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。 - position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。约束：offset+length<=buffer.size。

返回值：

类型	说明
number	实际读取的长度。

示例：

  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath, 0o2);
  let buf = new ArrayBuffer(4096);
  let num = fileio.readSync(fd, buf);

fileio.rmdir⁷⁺

rmdir(path: string): Promise<void>

删除目录，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.rmdir替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待删除目录的应用沙箱路径。

返回值：

类型	说明
Promise<void>	Promise对象。无返回值。

示例：

  import { BusinessError } from '@ohos.base';
  let dirPath = pathDir + '/testDir';
  fileio.rmdir(dirPath).then(() => {
    console.info("rmdir succeed");
  }).catch((err: BusinessError) => {
    console.info("rmdir failed with error:" + err);
  });

fileio.rmdir⁷⁺

rmdir(path: string, callback: AsyncCallback<void>): void

删除目录，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.rmdir替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待删除目录的应用沙箱路径。
callback	AsyncCallback<void>	是	异步删除目录之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let dirPath = pathDir + '/testDir';
  fileio.rmdir(dirPath, (err: BusinessError) => {
    // do something
    console.info("rmdir succeed");
  });

fileio.rmdirSync⁷⁺

rmdirSync(path: string): void

以同步方法删除目录。

说明：

从API version 9开始废弃，请使用fs.rmdirSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待删除目录的应用沙箱路径。

示例：

  let dirPath = pathDir + '/testDir';
  fileio.rmdirSync(dirPath);

fileio.unlink

unlink(path: string): Promise<void>

删除文件，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.unlink替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待删除文件的应用沙箱路径。

返回值：

类型	说明
Promise<void>	Promise对象。无返回值。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  fileio.unlink(filePath).then(() => {
    console.info("remove file succeed");
  }).catch((error: BusinessError) => {
    console.info("remove file failed with error:" + error);
  });

fileio.unlink

unlink(path: string, callback: AsyncCallback<void>): void

删除文件，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.unlink替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待删除文件的应用沙箱路径。
callback	AsyncCallback<void>	是	异步删除文件之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  fileio.unlink(filePath, (err: BusinessError) => {
    console.info("remove file succeed");
  });

fileio.unlinkSync

unlinkSync(path: string): void

以同步方法删除文件。

说明：

从API version 9开始废弃，请使用fs.unlinkSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待删除文件的应用沙箱路径。

示例：

  let filePath = pathDir + "/test.txt";
  fileio.unlinkSync(filePath);

fileio.write

write(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; position?: number; encoding?: string; }): Promise<number>

将数据写入文件，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.write替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待写入文件的文件描述符。
buffer	ArrayBuffer\|string	是	待写入文件的数据，可来自缓冲区或字符串。
options	Object	否	支持如下选项： - offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。 - length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。 - position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。 - encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认 ‘utf-8’。仅支持 ‘utf-8’。约束：offset+length<=buffer.size。

返回值：

类型	说明
Promise<number>	Promise对象。返回实际写入的长度。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath, 0o100|0o2, 0o666);
  fileio.write(fd, "hello, world").then((number: number) => {
    console.info("write data to file succeed and size is:" + number);
  }).catch((err: BusinessError) => {
    console.info("write data to file failed with error:" + err);
  });

fileio.write

write(fd: number, buffer: ArrayBuffer|string, options: { offset?: number; length?: number; position?: number; encoding?: string; }, callback: AsyncCallback<number>): void

将数据写入文件，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.write替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待写入文件的文件描述符。
buffer	ArrayBuffer\|string	是	待写入文件的数据，可来自缓冲区或字符串。
options	Object	否	支持如下选项： - offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。 - length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。 - position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。 - encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认 ‘utf-8’。仅支持 ‘utf-8’。约束：offset+length<=buffer.size。
callback	AsyncCallback<number>	是	异步将数据写入完成后执行的回调函数。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath, 0o100|0o2, 0o666);
  fileio.write(fd, "hello, world", (err: BusinessError, bytesWritten: number) => {
    if (bytesWritten) {
      console.info("write data to file succeed and size is:" + bytesWritten);
    }
  });

fileio.writeSync

writeSync(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; position?: number; encoding?: string; }): number

以同步方法将数据写入文件。

说明：

从API version 9开始废弃，请使用fs.writeSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待写入文件的文件描述符。
buffer	ArrayBuffer\|string	是	待写入文件的数据，可来自缓冲区或字符串。
options	Object	否	支持如下选项： - offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。 - length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。 - position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。 - encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认 ‘utf-8’。仅支持 ‘utf-8’。约束：offset+length<=buffer.size。

返回值：

类型	说明
number	实际写入的长度。

示例：

  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath, 0o100|0o2, 0o666);
  let num = fileio.writeSync(fd, "hello, world");

fileio.hash

hash(path: string, algorithm: string): Promise<string>

计算文件的哈希值，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用hash.write替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待计算哈希值文件的应用沙箱路径。
algorithm	string	是	哈希计算采用的算法。可选 “md5”、”sha1” 或 “sha256”。建议采用安全强度更高的 “sha256”。

返回值：

类型	说明
Promise<string>	Promise对象。返回文件的哈希值。表示为十六进制数字串，所有字母均大写。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  fileio.hash(filePath, "sha256").then((str: string) => {
    console.info("calculate file hash succeed:" + str);
  }).catch((err: BusinessError) => {
    console.info("calculate file hash failed with error:" + err);
  });

fileio.hash

hash(path: string, algorithm: string, callback: AsyncCallback<string>): void

计算文件的哈希值，使用callback异步回调。

说明：

从API version 9开始废弃，请使用hash.write替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待计算哈希值文件的应用沙箱路径。
algorithm	string	是	哈希计算采用的算法。可选 “md5”、”sha1” 或 “sha256”。建议采用安全强度更高的 “sha256”。
callback	AsyncCallback<string>	是	异步计算文件哈希操作之后的回调函数（其中给定文件哈希值表示为十六进制数字串，所有字母均大写）。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  fileio.hash(filePath, "sha256", (err: BusinessError, hashStr: string) => {
    if (hashStr) {
      console.info("calculate file hash succeed:" + hashStr);
    }
  });

fileio.chmod⁷⁺

chmod(path: string, mode: number): Promise<void>

改变文件权限，使用Promise异步回调。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	所需变更权限的文件的应用沙箱路径。
mode	number	是	改变文件权限，可给定如下权限，以按位或的方式追加权限。 - 0o700：所有者具有读、写及可执行权限。 - 0o400：所有者具有读权限。 - 0o200：所有者具有写权限。 - 0o100：所有者具有可执行权限。 - 0o070：所有用户组具有读、写及可执行权限。 - 0o040：所有用户组具有读权限。 - 0o020：所有用户组具有写权限。 - 0o010：所有用户组具有可执行权限。 - 0o007：其余用户具有读、写及可执行权限。 - 0o004：其余用户具有读权限。 - 0o002：其余用户具有写权限。 - 0o001：其余用户具有可执行权限。

返回值：

类型	说明
Promise<void>	Promise对象。无返回值。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  fileio.chmod(filePath, 0o700).then(() => {
    console.info("chmod succeed");
  }).catch((err: BusinessError) => {
    console.info("chmod failed with error:" + err);
  });

fileio.chmod⁷⁺

chmod(path: string, mode: number, callback: AsyncCallback<void>): void

改变文件权限，使用callback异步回调。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	所需变更权限的文件的应用沙箱路径。
mode	number	是	改变文件权限，可给定如下权限，以按位或的方式追加权限。 - 0o700：所有者具有读、写及可执行权限。 - 0o400：所有者具有读权限。 - 0o200：所有者具有写权限。 - 0o100：所有者具有可执行权限。 - 0o070：所有用户组具有读、写及可执行权限。 - 0o040：所有用户组具有读权限。 - 0o020：所有用户组具有写权限。 - 0o010：所有用户组具有可执行权限。 - 0o007：其余用户具有读、写及可执行权限。 - 0o004：其余用户具有读权限。 - 0o002：其余用户具有写权限。 - 0o001：其余用户具有可执行权限。
callback	AsyncCallback<void>	是	异步改变文件权限之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  fileio.chmod(filePath, 0o700, (err: BusinessError) => {
    // do something
  });

fileio.chmodSync⁷⁺

chmodSync(path: string, mode: number): void

以同步方法改变文件权限。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	所需变更权限的文件的应用沙箱路径。
mode	number	是	改变文件权限，可给定如下权限，以按位或的方式追加权限。 - 0o700：所有者具有读、写及可执行权限。 - 0o400：所有者具有读权限。 - 0o200：所有者具有写权限。 - 0o100：所有者具有可执行权限。 - 0o070：所有用户组具有读、写及可执行权限。 - 0o040：所有用户组具有读权限。 - 0o020：所有用户组具有写权限。 - 0o010：所有用户组具有可执行权限。 - 0o007：其余用户具有读、写及可执行权限。 - 0o004：其余用户具有读权限。 - 0o002：其余用户具有写权限。 - 0o001：其余用户具有可执行权限。

示例：

  let filePath = pathDir + "/test.txt";
  fileio.chmodSync(filePath, 0o700);

fileio.fstat⁷⁺

fstat(fd: number): Promise<Stat>

基于文件描述符获取文件状态信息，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.stat替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待获取文件状态的文件描述符。

返回值：

类型	说明
Promise<Stat>	Promise对象。返回表示文件状态的具体信息。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  fileio.fstat(fd).then((stat: fileio.Stat) => {
    console.info("fstat succeed, the size of file is " + stat.size);
  }).catch((err: BusinessError) => {
    console.info("fstat failed with error:" + err);
  });

fileio.fstat⁷⁺

fstat(fd: number, callback: AsyncCallback<Stat>): void

基于文件描述符获取文件状态信息，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.stat替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待获取文件状态的文件描述符。
callback	AsyncCallback<Stat>	是	异步获取文件状态信息之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  fileio.fstat(fd, (err: BusinessError) => {
    // do something
  });

fileio.fstatSync⁷⁺

fstatSync(fd: number): Stat

以同步方法基于文件描述符获取文件状态信息。

说明：

从API version 9开始废弃，请使用fs.statSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待获取文件状态的文件描述符。

返回值：

类型	说明
Stat	表示文件状态的具体信息。

示例：

  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  let stat = fileio.fstatSync(fd);

fileio.ftruncate⁷⁺

ftruncate(fd: number, len?: number): Promise<void>

基于文件描述符截断文件，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.truncate替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待截断文件的文件描述符。
len	number	否	文件截断后的长度，以字节为单位。

返回值：

类型	说明
Promise<void>	Promise对象。无返回值。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  fileio.ftruncate(fd, 5).then(() => {
    console.info("truncate file succeed");
  }).catch((err: BusinessError) => {
    console.info("truncate file failed with error:" + err);
  });

fileio.ftruncate⁷⁺

ftruncate(fd: number, len?: number, callback: AsyncCallback<void>): void

基于文件描述符截断文件，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.truncate替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待截断文件的文件描述符。
len	number	否	文件截断后的长度，以字节为单位。
callback	AsyncCallback<void>	是	回调函数，本调用无返回值。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  let len = 5;
  fileio.ftruncate(fd, 5, (err: BusinessError) => {
    // do something
  });

fileio.ftruncateSync⁷⁺

ftruncateSync(fd: number, len?: number): void

以同步方法基于文件描述符截断文件。

说明：

从API version 9开始废弃，请使用fs.truncateSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待截断文件的文件描述符。
len	number	否	文件截断后的长度，以字节为单位。

示例：

  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  let len = 5;
  fileio.ftruncateSync(fd, len);

fileio.truncate⁷⁺

truncate(path: string, len?: number): Promise<void>

基于文件路径截断文件，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.truncate替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待截断文件的应用沙箱路径。
len	number	否	文件截断后的长度，以字节为单位。

返回值：

类型	说明
Promise<void>	Promise对象。无返回值。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let len = 5;
  fileio.truncate(filePath, len).then(() => {
    console.info("truncate file succeed");
  }).catch((err: BusinessError) => {
    console.info("truncate file failed with error:" + err);
  });

fileio.truncate⁷⁺

truncate(path: string, len?: number, callback: AsyncCallback<void>): void

基于文件路径截断文件，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.truncate替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待截断文件的应用沙箱路径。
len	number	否	文件截断后的长度，以字节为单位。
callback	AsyncCallback<void>	是	回调函数，本调用无返回值。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let len = 5;
  fileio.truncate(filePath, len, (err: BusinessError) => {
    // do something
  });

fileio.truncateSync⁷⁺

truncateSync(path: string, len?: number): void

以同步方法基于文件路径截断文件。

说明：

从API version 9开始废弃，请使用fs.truncateSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待截断文件的应用沙箱路径。
len	number	否	文件截断后的长度，以字节为单位。

示例：

  let filePath = pathDir + "/test.txt";
  let len = 5;
  fileio.truncateSync(filePath, len);

fileio.readText⁷⁺

readText(filePath: string, options?: { position?: number; length?: number; encoding?: string; }): Promise<string>

基于文本方式读取文件（即直接读取文件的文本内容），使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.readText替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
filePath	string	是	待读取文件的应用沙箱路径。
options	Object	否	支持如下选项： - position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。 - length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。 - encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 ‘utf-8’，仅支持 ‘utf-8’。

返回值：

类型	说明
Promise<string>	Promise对象。返回读取文件的内容。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  fileio.readText(filePath).then((str: string) => {
    console.info("readText succeed:" + str);
  }).catch((err: BusinessError) => {
    console.info("readText failed with error:" + err);
  });

fileio.readText⁷⁺

readText(filePath: string, options: { position?: number; length?: number; encoding?: string; }, callback: AsyncCallback<string>): void

基于文本方式读取文件（即直接读取文件的文本内容），使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.readText替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
filePath	string	是	待读取文件的应用沙箱路径。
options	Object	否	支持如下选项： - position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。 - length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。 - encoding，string类型，表示数据的编码方式，默认 ‘utf-8’，仅支持 ‘utf-8’。
callback	AsyncCallback<string>	是	回调函数，返回读取文件的内容。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  class Option {
    length: number = 4096;
    position: number = 0;
    encoding: string = 'utf-8';
  }
  let option = new Option();
  option.position = 1;
  option.encoding = 'utf-8';
  fileio.readText(filePath, option, (err: BusinessError, str: string) => {
    // do something
  });

fileio.readTextSync⁷⁺

readTextSync(filePath: string, options?: { position?: number; length?: number; encoding?: string; }): string

以同步方法基于文本方式读取文件（即直接读取文件的文本内容）。

说明：

从API version 9开始废弃，请使用fs.readTextSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
filePath	string	是	待读取文件的应用沙箱路径。
options	Object	否	支持如下选项： - position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。 - length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。 - encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 ‘utf-8’，仅支持 ‘utf-8’。

返回值：

类型	说明
string	返回读取文件的内容。

示例：

  let filePath = pathDir + "/test.txt";
  class Option {
    length: number = 4096;
    position: number = 0;
    encoding: string = 'utf-8';
  }
  let option = new Option();
  option.position = 1;
  option.length = 3;
  let str = fileio.readTextSync(filePath, option);

fileio.lstat⁷⁺

lstat(path: string): Promise<Stat>

获取链接信息，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.lstat替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	目标文件的应用沙箱路径。

返回值：

类型	说明
Promise<Stat>	promise对象，返回文件对象，表示文件的具体信息，详情见stat。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  fileio.lstat(filePath).then((stat: fileio.Stat) => {
    console.info("get link status succeed, the size of file is" + stat.size);
  }).catch((err: BusinessError) => {
    console.info("get link status failed with error:" + err);
  });

fileio.lstat⁷⁺

lstat(path: string, callback: AsyncCallback<Stat>): void

获取链接信息，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.lstat替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	目标文件的应用沙箱路径。
callback	AsyncCallback<Stat>	是	回调函数，返回文件的具体信息。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  fileio.lstat(filePath, (err: BusinessError, stat: fileio.Stat) => {
    // do something
  });

fileio.lstatSync⁷⁺

lstatSync(path: string): Stat

以同步方法获取链接信息。

说明：

从API version 9开始废弃，请使用fs.lstatSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	目标文件的应用沙箱路径。

返回值：

类型	说明
Stat	表示文件的具体信息。

示例：

  let filePath = pathDir + "/test.txt";
  let stat = fileio.lstatSync(filePath);

fileio.rename⁷⁺

rename(oldPath: string, newPath: string): Promise<void>

重命名文件，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.rename替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
oldPath	string	是	目标文件的当前应用沙箱路径。
newPath	string	是	目标文件的新应用沙箱路径。

返回值：

类型	说明
Promise<void>	Promise对象。无返回值。

示例：

  import { BusinessError } from '@ohos.base';
  let srcFile = pathDir + "/test.txt";
  let dstFile = pathDir + '/new.txt';
  fileio.rename(srcFile, dstFile).then(() => {
    console.info("rename succeed");
  }).catch((err: BusinessError) => {
    console.info("rename failed with error:" + err);
  });

fileio.rename⁷⁺

rename(oldPath: string, newPath: string, callback: AsyncCallback<void>): void

重命名文件，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.rename替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
oldPath	string	是	目标文件的当前应用沙箱路径。
newPath	string	是	目标文件的新应用沙箱路径。
callback	AsyncCallback<void>	是	异步重命名文件之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let srcFile = pathDir + "/test.txt";
  let dstFile = pathDir + '/new.txt';
  fileio.rename(srcFile, dstFile, (err: BusinessError) => {
  });

fileio.renameSync⁷⁺

renameSync(oldPath: string, newPath: string): void

以同步方法重命名文件。

说明：

从API version 9开始废弃，请使用fs.renameSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
oldPath	string	是	目标文件的当前应用沙箱路径。
newPath	string	是	目标文件的新应用沙箱路径。

示例：

  let srcFile = pathDir + "/test.txt";
  let dstFile = pathDir + '/new.txt';
  fileio.renameSync(srcFile, dstFile);

fileio.fsync⁷⁺

fsync(fd: number): Promise<void>

同步文件数据，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.fsync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待同步文件的文件描述符。

返回值：

类型	说明
Promise<void>	Promise对象。无返回值。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  fileio.fsync(fd).then(() => {
    console.info("sync data succeed");
  }).catch((err: BusinessError) => {
    console.info("sync data failed with error:" + err);
  });

fileio.fsync⁷⁺

fsync(fd: number, callback: AsyncCallback<void>): void

同步文件数据，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.fsync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待同步文件的文件描述符。
Callback	AsyncCallback<void>	是	异步将文件数据同步之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  fileio.fsync(fd, (err: BusinessError) => {
    // do something
  });

fileio.fsyncSync⁷⁺

fsyncSync(fd: number): void

以同步方法同步文件数据。

说明：

从API version 9开始废弃，请使用fs.fsyncSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待同步文件的文件描述符。

示例：

  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  fileio.fsyncSync(fd);

fileio.fdatasync⁷⁺

fdatasync(fd: number): Promise<void>

实现文件内容数据同步，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.fdatasync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待同步文件的文件描述符。

返回值：

类型	说明
Promise<void>	Promise对象。无返回值。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  fileio.fdatasync(fd).then(() => {
    console.info("sync data succeed");
  }).catch((err: BusinessError) => {
    console.info("sync data failed with error:" + err);
  });

fileio.fdatasync⁷⁺

fdatasync(fd: number, callback: AsyncCallback<void>): void

实现文件内容数据同步，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.fdatasync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待同步文件的文件描述符。
callback	AsyncCallback<void>	是	异步将文件内容数据同步之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  fileio.fdatasync (fd, (err: BusinessError) => {
    // do something
  });

fileio.fdatasyncSync⁷⁺

fdatasyncSync(fd: number): void

以同步方法实现文件内容数据同步。

说明：

从API version 9开始废弃，请使用fs.fdatasyncSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待同步文件的文件描述符。

示例：

  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  let stat = fileio.fdatasyncSync(fd);

fileio.symlink⁷⁺

symlink(target: string, srcPath: string): Promise<void>

基于文件路径创建符号链接，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.symlink替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
target	string	是	目标文件的应用沙箱路径。
srcPath	string	是	符号链接文件的应用沙箱路径。

返回值：

类型	说明
Promise<void>	Promise对象。无返回值。

示例：

  import { BusinessError } from '@ohos.base';
  let srcFile = pathDir + "/test.txt";
  let dstFile = pathDir + '/test';
  fileio.symlink(srcFile, dstFile).then(() => {
    console.info("symlink succeed");
  }).catch((err: BusinessError) => {
    console.info("symlink failed with error:" + err);
  });

fileio.symlink⁷⁺

symlink(target: string, srcPath: string, callback: AsyncCallback<void>): void

基于文件路径创建符号链接，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.symlink替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
target	string	是	目标文件的应用沙箱路径。
srcPath	string	是	符号链接文件的应用沙箱路径。
callback	AsyncCallback<void>	是	异步创建符号链接信息之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let srcFile = pathDir + "/test.txt";
  let dstFile = pathDir + '/test';
  fileio.symlink(srcFile, dstFile, (err: BusinessError) => {
    // do something
  });

fileio.symlinkSync⁷⁺

symlinkSync(target: string, srcPath: string): void

以同步的方法基于文件路径创建符号链接。

说明：

从API version 9开始废弃，请使用fs.symlinkSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
target	string	是	目标文件的应用沙箱路径。
srcPath	string	是	符号链接文件的应用沙箱路径。

示例：

  let srcFile = pathDir + "/test.txt";
  let dstFile = pathDir + '/test';
  fileio.symlinkSync(srcFile, dstFile);

fileio.chown⁷⁺

chown(path: string, uid: number, gid: number): Promise<void>

基于文件路径改变文件所有者，使用Promise异步回调。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待改变文件的应用沙箱路径。
uid	number	是	新的UID（UserID）。
gid	number	是	新的GID（GroupID）。

返回值：

类型	说明
Promise<void>	Promise对象。无返回值。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let stat = fileio.statSync(filePath);
  fileio.chown(filePath, stat.uid, stat.gid).then(() => {
    console.info("chown succeed");
  }).catch((err: BusinessError) => {
    console.info("chown failed with error:" + err);
  });

fileio.chown⁷⁺

chown(path: string, uid: number, gid: number, callback: AsyncCallback<void>): void

基于文件路径改变文件所有者，使用callback异步回调。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待改变文件的应用沙箱路径。
uid	number	是	新的UID。
gid	number	是	新的GID。
callback	AsyncCallback<void>	是	异步改变文件所有者之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let stat = fileio.statSync(filePath)
  fileio.chown(filePath, stat.uid, stat.gid, (err: BusinessError) => {
    // do something
  });

fileio.chownSync⁷⁺

chownSync(path: string, uid: number, gid: number): void

以同步的方法基于文件路径改变文件所有者。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待改变文件的应用沙箱路径。
uid	number	是	新的UID。
gid	number	是	新的GID。

示例：

  let filePath = pathDir + "/test.txt";
  let stat = fileio.statSync(filePath)
  fileio.chownSync(filePath, stat.uid, stat.gid);

fileio.mkdtemp⁷⁺

mkdtemp(prefix: string): Promise<string>

创建临时目录，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.mkdtemp替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
prefix	string	是	用随机产生的字符串替换以“XXXXXX”结尾目录路径。

返回值：

类型	说明
Promise<string>	Promise对象。返回生成的唯一目录路径。

示例：

  import { BusinessError } from '@ohos.base';
  fileio.mkdtemp(pathDir + "/XXXXXX").then((pathDir: string) => {
    console.info("mkdtemp succeed:" + pathDir);
  }).catch((err: BusinessError) => {
    console.info("mkdtemp failed with error:" + err);
  });

fileio.mkdtemp⁷⁺

mkdtemp(prefix: string, callback: AsyncCallback<string>): void

创建临时目录，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.mkdtemp替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
prefix	string	是	用随机产生的字符串替换以“XXXXXX”结尾目录路径。
callback	AsyncCallback<string>	是	异步创建临时目录之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  fileio.mkdtemp(pathDir + "/XXXXXX", (err: BusinessError, res: string) => {
    // do something
  });

fileio.mkdtempSync⁷⁺

mkdtempSync(prefix: string): string

以同步的方法创建临时目录。

说明：

从API version 9开始废弃，请使用fs.mkdtempSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
prefix	string	是	用随机产生的字符串替换以“XXXXXX”结尾目录路径。

返回值：

类型	说明
string	产生的唯一目录路径。

示例：

  let res = fileio.mkdtempSync(pathDir + "/XXXXXX");

fileio.fchmod⁷⁺

fchmod(fd: number, mode: number): Promise<void>

基于文件描述符改变文件权限，使用Promise异步回调。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待改变文件的文件描述符。
mode	number	是	若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限。 - 0o700：所有者具有读、写及可执行权限。 - 0o400：所有者具有读权限。 - 0o200：所有者具有写权限。 - 0o100：所有者具有可执行权限。 - 0o070：所有用户组具有读、写及可执行权限。 - 0o040：所有用户组具有读权限。 - 0o020：所有用户组具有写权限。 - 0o010：所有用户组具有可执行权限。 - 0o007：其余用户具有读、写及可执行权限。 - 0o004：其余用户具有读权限。 - 0o002：其余用户具有写权限。 - 0o001：其余用户具有可执行权限。

返回值：

类型	说明
Promise<void>	Promise对象。无返回值。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  let mode: number = 0o700;
  fileio.fchmod(fd, mode).then(() => {
    console.info("chmod succeed");
  }).catch((err: BusinessError) => {
    console.info("chmod failed with error:" + err);
  });

fileio.fchmod⁷⁺

fchmod(fd: number, mode: number, callback: AsyncCallback<void>): void

基于文件描述符改变文件权限，使用callback异步回调。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待改变文件的文件描述符。
mode	number	是	若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限。 - 0o700：所有者具有读、写及可执行权限。 - 0o400：所有者具有读权限。 - 0o200：所有者具有写权限。 - 0o100：所有者具有可执行权限。 - 0o070：所有用户组具有读、写及可执行权限。 - 0o040：所有用户组具有读权限。 - 0o020：所有用户组具有写权限。 - 0o010：所有用户组具有可执行权限。 - 0o007：其余用户具有读、写及可执行权限。 - 0o004：其余用户具有读权限。 - 0o002：其余用户具有写权限。 - 0o001：其余用户具有可执行权限。
callback	AsyncCallback<void>	是	异步改变文件权限之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  let mode: number = 0o700;
  fileio.fchmod(fd, mode, (err: BusinessError) => {
    // do something
  });

fileio.fchmodSync⁷⁺

fchmodSync(fd: number, mode: number): void

以同步方法基于文件描述符改变文件权限。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待改变文件的文件描述符。
mode	number	是	若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限。 - 0o700：所有者具有读、写及可执行权限。 - 0o400：所有者具有读权限。 - 0o200：所有者具有写权限。 - 0o100：所有者具有可执行权限。 - 0o070：所有用户组具有读、写及可执行权限。 - 0o040：所有用户组具有读权限。 - 0o020：所有用户组具有写权限。 - 0o010：所有用户组具有可执行权限。 - 0o007：其余用户具有读、写及可执行权限。 - 0o004：其余用户具有读权限。 - 0o002：其余用户具有写权限。 - 0o001：其余用户具有可执行权限。

示例：

  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  let mode: number = 0o700;
  fileio.fchmodSync(fd, mode);

fileio.createStream⁷⁺

createStream(path: string, mode: string): Promise<Stream>

基于文件路径打开文件流，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.createStream替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待打开文件的应用沙箱路径。
mode	string	是	- r：打开只读文件，该文件必须存在。 - r+：打开可读写的文件，该文件必须存在。 - w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。 - w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。 - a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。 - a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。

返回值：

类型	说明
Promise<Stream>	Promise对象。返回文件流的结果。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  fileio.createStream(filePath, "r+").then((stream: fileio.Stream) => {
    console.info("createStream succeed");
  }).catch((err: BusinessError) => {
    console.info("createStream failed with error:" + err);
  });

fileio.createStream⁷⁺

createStream(path: string, mode: string, callback: AsyncCallback<Stream>): void

基于文件路径打开文件流，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.createStream替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待打开文件的应用沙箱路径。
mode	string	是	- r：打开只读文件，该文件必须存在。 - r+：打开可读写的文件，该文件必须存在。 - w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。 - w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。 - a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。 - a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。
callback	AsyncCallback<Stream>	是	异步打开文件流之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  fileio.createStream(filePath, "r+", (err: BusinessError, stream: fileio.Stream) => {
    // do something
  });

fileio.createStreamSync⁷⁺

createStreamSync(path: string, mode: string): Stream

以同步方法基于文件路径打开文件流。

说明：

从API version 9开始废弃，请使用fs.createStreamSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待打开文件的应用沙箱路径。
mode	string	是	- r：打开只读文件，该文件必须存在。 - r+：打开可读写的文件，该文件必须存在。 - w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。 - w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。 - a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。 - a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。

返回值：

类型	说明
Stream	返回文件流的结果。

示例：

  let filePath = pathDir + "/test.txt";
  let ss = fileio.createStreamSync(filePath, "r+");

fileio.fdopenStream⁷⁺

fdopenStream(fd: number, mode: string): Promise<Stream>

基于文件描述符打开文件流，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.fdopenStream替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待打开文件的文件描述符。
mode	string	是	- r：打开只读文件，该文件必须存在。 - r+：打开可读写的文件，该文件必须存在。 - w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。 - w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。 - a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。 - a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。

返回值：

类型	说明
Promise<Stream>	Promise对象。返回文件流的结果。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  fileio.fdopenStream(fd, "r+").then((stream: fileio.Stream) => {
    console.info("openStream succeed");
  }).catch((err: BusinessError) => {
    console.info("openStream failed with error:" + err);
  });

fileio.fdopenStream⁷⁺

fdopenStream(fd: number, mode: string, callback: AsyncCallback<Stream>): void

基于文件描述符打开文件流，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.fdopenStream替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待打开文件的文件描述符。
mode	string	是	- r：打开只读文件，该文件必须存在。 - r+：打开可读写的文件，该文件必须存在。 - w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。 - w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。 - a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。 - a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。
callback	AsyncCallback<Stream>	是	异步打开文件流之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  fileio.fdopenStream(fd, "r+", (err: BusinessError, stream: fileio.Stream) => {
    // do something
  });

fileio.fdopenStreamSync⁷⁺

fdopenStreamSync(fd: number, mode: string): Stream

以同步方法基于文件描述符打开文件流。

说明：

从API version 9开始废弃，请使用fs.fdopenStreamSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待打开文件的文件描述符。
mode	string	是	- r：打开只读文件，该文件必须存在。 - r+：打开可读写的文件，该文件必须存在。 - w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。 - w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。 - a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。 - a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。

返回值：

类型	说明
Stream	返回文件流的结果。

示例：

  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  let ss = fileio.fdopenStreamSync(fd, "r+");

fileio.fchown⁷⁺

fchown(fd: number, uid: number, gid: number): Promise<void>

基于文件描述符改变文件所有者，使用Promise异步回调。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待改变文件的文件描述符。
uid	number	是	文件所有者的UID。
gid	number	是	文件所有组的GID。

返回值：

类型	说明
Promise<void>	Promise对象。无返回值。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  let stat = fileio.statSync(filePath);
  fileio.fchown(fd, stat.uid, stat.gid).then(() => {
    console.info("chown succeed");
  }).catch((err: BusinessError) => {
    console.info("chown failed with error:" + err);
  });

fileio.fchown⁷⁺

fchown(fd: number, uid: number, gid: number, callback: AsyncCallback<void>): void

基于文件描述符改变文件所有者，使用callback异步回调。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待改变文件的文件描述符。
uid	number	是	文件所有者的UID。
gid	number	是	文件所有组的GID。
callback	AsyncCallback<void>	是	异步改变文件所有者之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  let stat = fileio.statSync(filePath);
  fileio.fchown(fd, stat.uid, stat.gid, (err: BusinessError) => {
    // do something
  });

fileio.fchownSync⁷⁺

fchownSync(fd: number, uid: number, gid: number): void

以同步方法基于文件描述符改变文件所有者。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
fd	number	是	待改变文件的文件描述符。
uid	number	是	文件所有者的UID。
gid	number	是	文件所有组的GID。

示例：

  let filePath = pathDir + "/test.txt";
  let fd = fileio.openSync(filePath);
  let stat = fileio.statSync(filePath);
  fileio.fchownSync(fd, stat.uid, stat.gid);

fileio.lchown⁷⁺

lchown(path: string, uid: number, gid: number): Promise<void>

基于文件路径改变文件所有者，更改符号链接本身的所有者，而不是符号链接所指向的实际文件，使用Promise异步回调。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待打开文件的应用沙箱路径。
uid	number	是	新的UID。
gid	number	是	新的GID。

返回值：

类型	说明
Promise<void>	Promise对象。无返回值。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let stat = fileio.statSync(filePath);
  fileio.lchown(filePath, stat.uid, stat.gid).then(() => {
    console.info("chown succeed");
  }).catch((err: BusinessError) => {
    console.info("chown failed with error:" + err);
  });

fileio.lchown⁷⁺

lchown(path: string, uid: number, gid: number, callback: AsyncCallback<void>): void

基于文件路径改变文件所有者，更改符号链接本身的所有者，而不是更改符号链接所指向的实际文件，使用callback异步回调。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待打开文件的应用沙箱路径。
uid	number	是	新的UID。
gid	number	是	新的GID。
callback	AsyncCallback<void>	是	异步改变文件所有者之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let stat = fileio.statSync(filePath);
  fileio.lchown(filePath, stat.uid, stat.gid, (err: BusinessError) => {
    // do something
  });

fileio.lchownSync⁷⁺

lchownSync(path: string, uid: number, gid: number): void

以同步方法基于文件路径改变文件所有者，更改符号链接本身的所有者，而不是更改符号链接所指向的实际文件。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
path	string	是	待打开文件的应用沙箱路径。
uid	number	是	新的UID。
gid	number	是	新的GID。

示例：

  let filePath = pathDir + "/test.txt";
  let stat = fileio.statSync(filePath);
  fileio.lchownSync(filePath, stat.uid, stat.gid);

fileio.createWatcher⁷⁺

createWatcher(filename: string, events: number, callback: AsyncCallback<number>): Watcher

监听文件或者目录的变化，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
filePath	string	是	待监视文件的应用沙箱路径。
events	number	是	- 1: 监听文件或者目录是否发生重命名。 - 2：监听文件或者目录内容的是否修改。 - 3：两者都有。
callback	AsyncCallback<number>	是	每发生变化一次，调用一次此函数。

返回值：

类型	说明
Watcher	Promise对象。返回文件变化监听的实例。

示例：

  let filePath = pathDir +"/test.txt";
  fileio.createWatcher(filePath, 1, (event: number) => {
    console.info("event: " + event);
  });

Readout

仅用于read方法，获取文件的读取结果。

说明：

从API version 9开始废弃。

系统能力：以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。

名称	类型	可读	可写	说明
bytesRead	number	是	是	实际读取长度。
offset	number	是	是	读取数据相对于缓冲区首地址的偏移。
buffer	ArrayBuffer	是	是	保存读取数据的缓冲区。

Stat

文件具体信息，在调用Stat的方法前，需要先通过stat()方法（同步或异步）来构建一个Stat实例。

说明：

从API version 9开始废弃，请使用fs.Stat替代。

系统能力：以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。

属性

名称	类型	可读	可写	说明
dev	number	是	否	标识包含该文件的主设备号。
ino	number	是	否	标识该文件。通常同设备上的不同文件的INO不同。
mode	number	是	否	表示文件类型及权限，其首 4 位表示文件类型，后 12 位表示权限。各特征位的含义如下： - 0o170000：可用于获取文件类型的掩码。 - 0o140000：文件是套接字。 - 0o120000：文件是符号链接。 - 0o100000：文件是一般文件。 - 0o060000：文件属于块设备。 - 0o040000：文件是目录。 - 0o020000：文件是字符设备。 - 0o010000：文件是命名管道，即FIFO。 - 0o0700：可用于获取用户权限的掩码。 - 0o0400：用户读，对于普通文件，所有者可读取文件；对于目录，所有者可读取目录项。 - 0o0200：用户写，对于普通文件，所有者可写入文件；对于目录，所有者可创建/删除目录项。 - 0o0100：用户执行，对于普通文件，所有者可执行文件；对于目录，所有者可在目录中搜索给定路径名。 - 0o0070：可用于获取用户组权限的掩码。 - 0o0040：用户组读，对于普通文件，所有用户组可读取文件；对于目录，所有用户组可读取目录项。 - 0o0020：用户组写，对于普通文件，所有用户组可写入文件；对于目录，所有用户组可创建/删除目录项。 - 0o0010：用户组执行，对于普通文件，所有用户组可执行文件；对于目录，所有用户组是否可在目录中搜索给定路径名。 - 0o0007：可用于获取其他用户权限的掩码。 - 0o0004：其他读，对于普通文件，其余用户可读取文件；对于目录，其他用户组可读取目录项。 - 0o0002：其他写，对于普通文件，其余用户可写入文件；对于目录，其他用户组可创建/删除目录项。 - 0o0001：其他执行，对于普通文件，其余用户可执行文件；对于目录，其他用户组可在目录中搜索给定路径名。
nlink	number	是	否	文件的硬链接数。
uid	number	是	否	文件所有者的ID。
gid	number	是	否	文件所有组的ID。
rdev	number	是	否	标识包含该文件的从设备号。
size	number	是	否	文件的大小，以字节为单位。仅对普通文件有效。
blocks	number	是	否	文件占用的块数，计算时块大小按512B计算。
atime	number	是	否	上次访问该文件的时间，表示距1970年1月1日0时0分0秒的秒数。
mtime	number	是	否	上次修改该文件的时间，表示距1970年1月1日0时0分0秒的秒数。
ctime	number	是	否	最近改变文件状态的时间，表示距1970年1月1日0时0分0秒的秒数。

isBlockDevice

isBlockDevice(): boolean

用于判断文件是否是块特殊文件。一个块特殊文件只能以块为粒度进行访问，且访问的时候带缓存。

说明：

从API version 9开始废弃，请使用fs.Stat.isBlockDevice替代。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

类型	说明
boolean	表示文件是否是块特殊设备。

示例：

  let filePath = pathDir + "/test.txt";
  let isBLockDevice = fileio.statSync(filePath).isBlockDevice();

isCharacterDevice

isCharacterDevice(): boolean

用于判断文件是否是字符特殊文件。一个字符特殊设备可进行随机访问，且访问的时候不带缓存。

说明：

从API version 9开始废弃，请使用fs.Stat.isCharacterDevice替代。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

类型	说明
boolean	表示文件是否是字符特殊设备。

示例：

  let filePath = pathDir + "/test.txt";
  let isCharacterDevice = fileio.statSync(filePath).isCharacterDevice();

isDirectory

isDirectory(): boolean

用于判断文件是否是目录。

说明：

从API version 9开始废弃，请使用fs.Stat.isDirectory替代。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

类型	说明
boolean	表示文件是否是目录。

示例：

  let dirPath = pathDir + "/test";
  let isDirectory = fileio.statSync(dirPath).isDirectory();

isFIFO

isFIFO(): boolean

用于判断文件是否是命名管道（有时也称为FIFO）。命名管道通常用于进程间通信。

说明：

从API version 9开始废弃，请使用fs.Stat.isFIFO替代。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

类型	说明
boolean	表示文件是否是 FIFO。

示例：

  let filePath = pathDir + "/test.txt";
  let isFIFO = fileio.statSync(filePath).isFIFO();

isFile

isFile(): boolean

用于判断文件是否是普通文件。

说明：

从API version 9开始废弃，请使用fs.Stat.isFile替代。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

类型	说明
boolean	表示文件是否是普通文件。

示例：

  let filePath = pathDir + "/test.txt";
  let isFile = fileio.statSync(filePath).isFile();

isSocket

isSocket(): boolean

用于判断文件是否是套接字。

说明：

从API version 9开始废弃，请使用fs.Stat.isSocket替代。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

类型	说明
boolean	表示文件是否是套接字。

示例：

  let filePath = pathDir + "/test.txt";
  let isSocket = fileio.statSync(filePath).isSocket();

isSymbolicLink

isSymbolicLink(): boolean

用于判断文件是否是符号链接。

说明：

从API version 9开始废弃，请使用fs.Stat.isSymbolicLink替代。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

类型	说明
boolean	表示文件是否是符号链接。

示例：

  let filePath = pathDir + "/test";
  let isSymbolicLink = fileio.statSync(filePath).isSymbolicLink();

Watcher⁷⁺

Watcher是文件变化监听的实例，调用Watcher.stop()方法（同步或异步）来停止文件监听。

stop⁷⁺

stop(): Promise<void>

关闭watcher监听，使用Promise异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

示例：

  let filePath = pathDir + "/test.txt";
  let watcher = fileio.createWatcher(filePath, 1, (event: number) => {
    console.info("event: " + event);
  });
  watcher.stop().then(() => {
    console.info("close watcher succeed");
  });

stop⁷⁺

stop(callback: AsyncCallback<void>): void

关闭watcher监听，使用callback异步回调。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	以异步方法关闭watcher监听之后的回调。

示例：

  let filePath = pathDir +"/test.txt";
  let watcher = fileio.createWatcher(filePath, 1, (event: number) => {
    console.info("event: " + event);
  });
  watcher.stop(() => {
    console.info("close watcher succeed");
  })

Stream

文件流，在调用Stream的方法前，需要先通过createStream()方法（同步或异步）来构建一个Stream实例。

说明：

从API version 9开始废弃，请使用fs.Stream替代。

close⁷⁺

close(): Promise<void>

关闭文件流，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.Stream.close替代。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

类型	说明
Promise<void>	Promise对象。返回表示异步关闭文件流的结果。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let ss = fileio.createStreamSync(filePath, "r+");
  ss.close().then(() => {
    console.info("close fileStream succeed");
  }).catch((err: BusinessError) => {
    console.info("close fileStream  failed with error:" + err);
  });

close⁷⁺

close(callback: AsyncCallback<void>): void

异步关闭文件流，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.Stream.close替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	异步关闭文件流之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let ss = fileio.createStreamSync(filePath, "r+");
  ss.close((err: BusinessError) => {
    // do something
  });

closeSync

closeSync(): void

同步关闭文件流。

说明：

从API version 9开始废弃，请使用fs.Stream.closeSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

示例：

  let filePath = pathDir + "/test.txt";
  let ss = fileio.createStreamSync(filePath, "r+");
  ss.closeSync();

flush⁷⁺

flush(): Promise<void>

刷新文件流，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.Stream.flush替代。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

类型	说明
Promise<void>	Promise对象。返回表示异步刷新文件流的结果。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let ss = fileio.createStreamSync(filePath, "r+");
  ss.flush().then(() => {
    console.info("flush succeed");
  }).catch((err: BusinessError) => {
    console.info("flush failed with error:" + err);
  });

flush⁷⁺

flush(callback: AsyncCallback<void>): void

异步刷新文件流，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.Stream.flush替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	异步刷新文件流后的回调函数。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let ss = fileio.createStreamSync(filePath, "r+");
  ss.flush((err: BusinessError) => {
    // do something
  });

flushSync⁷⁺

flushSync(): void

同步刷新文件流。

说明：

从API version 9开始废弃，请使用fs.Stream.flushSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

示例：

  let filePath = pathDir + "/test.txt";
  let ss = fileio.createStreamSync(filePath, "r+");
  ss.flushSync();

write⁷⁺

write(buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; position?: number; encoding?: string; }): Promise<number>

将数据写入流文件，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.Stream.write替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
buffer	ArrayBuffer\|string	是	待写入文件的数据，可来自缓冲区或字符串。
options	Object	否	支持如下选项： - offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。 - length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。 - position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。 - encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认 ‘utf-8’。仅支持 ‘utf-8’。约束：offset+length<=buffer.size。

返回值：

类型	说明
Promise<number>	Promise对象。返回实际写入的长度。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let ss = fileio.createStreamSync(filePath, "r+");
  class Option {
    offset: number = 0;
    length: number = 4096;
    position: number = 0;
    encoding: string = 'utf-8';
  }
  let option = new Option();
  option.offset = 1;
  option.length = 5;
  option.position = 5;
  ss.write("hello, world", option).then((number: number) => {
    console.info("write succeed and size is:" + number);
  }).catch((err: BusinessError) => {
    console.info("write failed with error:" + err);
  });

write⁷⁺

write(buffer: ArrayBuffer|string, options: { offset?: number; length?: number; position?: number; encoding?: string; }, callback: AsyncCallback<number>): void

将数据写入流文件，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.Stream.write替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
buffer	ArrayBuffer\|string	是	待写入文件的数据，可来自缓冲区或字符串。
options	Object	否	支持如下选项： - offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。 - length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。 - position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。 - encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认 ‘utf-8’。仅支持 ‘utf-8’。约束：offset+length<=buffer.size。
callback	AsyncCallback<number>	是	异步写入完成后执行的回调函数。

示例：

  import { BusinessError } from '@ohos.base';
  let filePath = pathDir + "/test.txt";
  let ss = fileio.createStreamSync(filePath, "r+");
  class Option {
    offset: number = 0;
    length: number = 4096;
    position: number = 0;
    encoding: string = 'utf-8';
  }
  let option = new Option();
  option.offset = 1;
  option.length = 5;
  option.position = 5;
  ss.write("hello, world", option, (err: BusinessError, bytesWritten: number) => {
    if (bytesWritten) {
      // do something
      console.info("write succeed and size is:" + bytesWritten);
    }
  });

writeSync⁷⁺

writeSync(buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; position?: number; encoding?: string; }): number

以同步方法将数据写入流文件。

说明：

从API version 9开始废弃，请使用fs.Stream.writeSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
buffer	ArrayBuffer\|string	是	待写入文件的数据，可来自缓冲区或字符串。
options	Object	否	支持如下选项： - offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。 - length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。 - position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。 - encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认 ‘utf-8’。仅支持 ‘utf-8’。约束：offset+length<=buffer.size。

返回值：

类型	说明
number	实际写入的长度。

示例：

  let filePath = pathDir + "/test.txt";
  let ss = fileio.createStreamSync(filePath,"r+");
  class Option {
    offset: number = 0;
    length: number = 4096;
    position: number = 0;
    encoding: string = 'utf-8';
  }
  let option = new Option();
  option.offset = 1;
  option.length = 5;
  option.position = 5;
  let num = ss.writeSync("hello, world", option);

read⁷⁺

read(buffer: ArrayBuffer, options?: { position?: number; offset?: number; length?: number; }): Promise<ReadOut>

从流文件读取数据，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.Stream.read替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
buffer	ArrayBuffer	是	用于读取文件的缓冲区。
options	Object	否	支持如下选项： - offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。 - length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。 - position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。约束：offset+length<=buffer.size。

返回值：

类型	说明
Promise<ReadOut>	Promise对象。返回读取的结果。

示例：

  import { BusinessError } from '@ohos.base';
  import buffer from '@ohos.buffer';
  import { ReadOut } from '@ohos.fileio';
  let filePath = pathDir + "/test.txt";
  let ss = fileio.createStreamSync(filePath, "r+");
  let arrayBuffer = new ArrayBuffer(4096);
  class Option {
    offset: number = 0;
    length: number = 4096;
    position: number = 0;
  }
  let option = new Option();
  option.offset = 1;
  option.length = 5;
  option.position = 5;
  ss.read(arrayBuffer, option).then((readResult: ReadOut) => {
    console.info("read data succeed");
    let buf = buffer.from(arrayBuffer, 0, readResult.bytesRead);
    console.info(`The content of file: ${buf.toString()}`);
  }).catch((err: BusinessError) => {
    console.info("read data failed with error:" + err);
  });

read⁷⁺

read(buffer: ArrayBuffer, options: { position?: number; offset?: number; length?: number; }, callback: AsyncCallback<ReadOut>): void

从流文件读取数据，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.Stream.read替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
buffer	ArrayBuffer	是	用于读取文件的缓冲区。
options	Object	否	支持如下选项： - offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。 - length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。 - position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。约束：offset+length<=buffer.size。
callback	AsyncCallback<ReadOut>	是	异步从流文件读取数据之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  import buffer from '@ohos.buffer';
  import { ReadOut } from '@ohos.fileio';
  let filePath = pathDir + "/test.txt";
  let ss = fileio.createStreamSync(filePath, "r+");
  let arrayBuffer = new ArrayBuffer(4096);
  class Option {
    offset: number = 0;
    length: number = 4096;
    position: number = 0;
  }
  let option = new Option();
  option.offset = 1;
  option.length = 5;
  option.position = 5;
  ss.read(arrayBuffer, option, (err: BusinessError, readResult: ReadOut) => {
    if (readResult.bytesRead) {
      console.info("read data succeed");
      let buf = buffer.from(arrayBuffer, 0, readResult.bytesRead);
      console.info(`The content of file: ${buf.toString()}`);
    }
  });

readSync⁷⁺

readSync(buffer: ArrayBuffer, options?: { position?: number; offset?: number; length?: number; }): number

以同步方法从流文件读取数据。

说明：

从API version 9开始废弃，请使用fs.Stream.readSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
buffer	ArrayBuffer	是	用于读取文件的缓冲区。
options	Object	否	支持如下选项： - offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。 - length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。 - position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。约束：offset+length<=buffer.size。

返回值：

类型	说明
number	实际读取的长度。

示例：

  let filePath = pathDir + "/test.txt";
  let ss = fileio.createStreamSync(filePath, "r+");
  class Option {
    offset: number = 0;
    length: number = 4096;
    position: number = 0;
  }
  let option = new Option();
  option.offset = 1;
  option.length = 5;
  option.position = 5;
  let buf = new ArrayBuffer(4096)
  let num = ss.readSync(buf, option);

Dir

管理目录，在调用Dir的方法前，需要先通过opendir方法（同步或异步）来构建一个Dir实例。

说明：

从API version 9开始废弃，请使用fs.listFile替代。

read

read(): Promise<Dirent>

读取下一个目录项，使用Promise异步回调。

说明：

从API version 9开始废弃，请使用fs.listFile替代。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

类型	说明
Promise<Dirent>	Promise对象。返回表示异步读取目录项的结果。

示例：

  import { BusinessError } from '@ohos.base';
  dir.read().then((dirent: fileio.Dirent) => {
    console.log("read succeed, the name of dirent is " + dirent.name);
  }).catch((err: BusinessError) => {
    console.info("read failed with error:" + err);
  });

read

read(callback: AsyncCallback<Dirent>): void

读取下一个目录项，使用callback异步回调。

说明：

从API version 9开始废弃，请使用fs.listFile替代。

系统能力：SystemCapability.FileManagement.File.FileIO

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Dirent>	是	异步读取下一个目录项之后的回调。

示例：

  import { BusinessError } from '@ohos.base';
  dir.read((err: BusinessError, dirent: fileio.Dirent) => {
    if (dirent) {
      // do something
      console.log("read succeed, the name of file is " + dirent.name);
    }
  });

readSync

readSync(): Dirent

同步读取下一个目录项。

说明：

从API version 9开始废弃，请使用fs.listFileSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

类型	说明
Dirent	表示一个目录项。

示例：

  let dirent = dir.readSync();

close⁷⁺

close(): Promise<void>

异步关闭目录，使用promise形式返回结果。目录被关闭后，Dir中持有的文件描述将被释放，后续将无法从Dir中读取目录项。

说明：

从API version 9开始废弃，请使用fs.listFile替代。

系统能力：SystemCapability.FileManagement.File.FileIO

示例：

  import { BusinessError } from '@ohos.base';
  dir.close().then(() => {
    console.info("close dir successfully");
  });

close⁷⁺

close(callback: AsyncCallback<void>): void

异步关闭目录，使用callback形式返回结果。目录被关闭后，Dir中持有的文件描述将被释放，后续将无法从Dir中读取目录项。

说明：

从API version 9开始废弃，请使用fs.listFile替代。

系统能力：SystemCapability.FileManagement.File.FileIO

示例：

  import { BusinessError } from '@ohos.base';
  dir.close((err: BusinessError) => {
    console.info("close dir successfully");
  });

closeSync

closeSync(): void

用于关闭目录。目录被关闭后，Dir中持有的文件描述将被释放，后续将无法从Dir中读取目录项。

说明：

从API version 9开始废弃，请使用fs.listFileSync替代。

系统能力：SystemCapability.FileManagement.File.FileIO

示例：

  dir.closeSync();

Dirent

在调用Dirent的方法前，需要先通过dir.read()方法（同步或异步）来构建一个Dirent实例。

说明：

从API version 9开始废弃，请使用fs.listFile替代。

系统能力：以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。

属性

名称	类型	可读	可写	说明
name	string	是	否	目录项的名称。

isBlockDevice

isBlockDevice(): boolean

用于判断当前目录项是否是块特殊文件。一个块特殊文件只能以块为粒度进行访问，且访问的时候带缓存。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

类型	说明
boolean	表示当前目录项是否是块特殊设备。

示例：

  let dir = fileio.opendirSync(pathDir);
  let isBLockDevice = dir.readSync().isBlockDevice();

isCharacterDevice

isCharacterDevice(): boolean

用于判断当前目录项是否是字符特殊设备。一个字符特殊设备可进行随机访问，且访问的时候不带缓存。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

类型	说明
boolean	表示当前目录项是否是字符特殊设备。

示例：

  let dir = fileio.opendirSync(pathDir);
  let isCharacterDevice = dir.readSync().isCharacterDevice();

isDirectory

isDirectory(): boolean

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

类型	说明
boolean	表示当前目录项是否是目录。

示例：

  let dir = fileio.opendirSync(pathDir);
  let isDirectory = dir.readSync().isDirectory();

isFIFO

isFIFO(): boolean

用于判断当前目录项是否是命名管道（有时也称为FIFO）。命名管道通常用于进程间通信。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

类型	说明
boolean	表示当前目录项是否是FIFO。

示例：

  let dir = fileio.opendirSync(pathDir);
  let isFIFO = dir.readSync().isFIFO();

isFile

isFile(): boolean

用于判断当前目录项是否是普通文件。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

类型	说明
boolean	表示当前目录项是否是普通文件。

示例：

  let dir = fileio.opendirSync(pathDir);
  let isFile = dir.readSync().isFile();

isSocket

isSocket(): boolean

用于判断当前目录项是否是套接字。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

类型	说明
boolean	表示当前目录项是否是套接字。

示例：

  let dir = fileio.opendirSync(pathDir);
  let isSocket = dir.readSync().isSocket();

isSymbolicLink

isSymbolicLink(): boolean

用于判断当前目录项是否是符号链接。

说明：

从API version 9开始废弃。

系统能力：SystemCapability.FileManagement.File.FileIO

返回值：

类型	说明
boolean	表示当前目录项是否是符号链接。

示例：

  let dir = fileio.opendirSync(pathDir);
  let isSymbolicLink = dir.readSync().isSymbolicLink();

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述（仅对系统应用开放）

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

0 赞

所属分类： 后端技术
本文标签： 软件鸿蒙
版权声明： 原创文章如转载，请注明本文链接: https://www.seaxiang.com/blog/bfff5e8aa8db4b06a31b6c4f4ba97320

harmony 鸿蒙@ohos.fileio (文件管理)

@ohos.fileio (文件管理)

导入模块

使用说明

fileio.stat

fileio.stat

fileio.statSync

fileio.opendir

fileio.opendir

fileio.opendirSync

fileio.access

fileio.access

fileio.accessSync

fileio.close7+

fileio.close7+

fileio.closeSync

fileio.copyFile

fileio.copyFile

fileio.copyFileSync

fileio.mkdir

fileio.mkdir

fileio.mkdirSync

fileio.open7+

fileio.open7+

fileio.openSync

fileio.read

fileio.read

fileio.readSync

fileio.rmdir7+

fileio.rmdir7+

fileio.rmdirSync7+

fileio.unlink

fileio.unlink

fileio.unlinkSync

fileio.write

fileio.write

fileio.writeSync

fileio.hash

fileio.hash

fileio.chmod7+

fileio.chmod7+

fileio.chmodSync7+

fileio.fstat7+

fileio.fstat7+

fileio.fstatSync7+

fileio.ftruncate7+

fileio.ftruncate7+

fileio.ftruncateSync7+

fileio.truncate7+

fileio.truncate7+

fileio.truncateSync7+

fileio.readText7+

fileio.readText7+

fileio.readTextSync7+

fileio.lstat7+

fileio.lstat7+

fileio.lstatSync7+

fileio.rename7+

fileio.rename7+

fileio.renameSync7+

fileio.fsync7+

fileio.fsync7+

fileio.fsyncSync7+

fileio.fdatasync7+

fileio.fdatasync7+

fileio.fdatasyncSync7+

fileio.symlink7+

fileio.symlink7+

fileio.symlinkSync7+

fileio.chown7+

fileio.chown7+

fileio.chownSync7+

fileio.mkdtemp7+

fileio.mkdtemp7+

fileio.mkdtempSync7+

fileio.fchmod7+

fileio.fchmod7+

fileio.fchmodSync7+

fileio.createStream7+

fileio.createStream7+

fileio.close⁷⁺

fileio.close⁷⁺

fileio.open⁷⁺

fileio.open⁷⁺

fileio.rmdir⁷⁺

fileio.rmdir⁷⁺

fileio.rmdirSync⁷⁺

fileio.chmod⁷⁺

fileio.chmod⁷⁺

fileio.chmodSync⁷⁺

fileio.fstat⁷⁺

fileio.fstat⁷⁺

fileio.fstatSync⁷⁺

fileio.ftruncate⁷⁺

fileio.ftruncate⁷⁺

fileio.ftruncateSync⁷⁺

fileio.truncate⁷⁺

fileio.truncate⁷⁺

fileio.truncateSync⁷⁺

fileio.readText⁷⁺

fileio.readText⁷⁺

fileio.readTextSync⁷⁺

fileio.lstat⁷⁺

fileio.lstat⁷⁺

fileio.lstatSync⁷⁺

fileio.rename⁷⁺

fileio.rename⁷⁺

fileio.renameSync⁷⁺

fileio.fsync⁷⁺

fileio.fsync⁷⁺

fileio.fsyncSync⁷⁺

fileio.fdatasync⁷⁺

fileio.fdatasync⁷⁺

fileio.fdatasyncSync⁷⁺

fileio.symlink⁷⁺

fileio.symlink⁷⁺

fileio.symlinkSync⁷⁺

fileio.chown⁷⁺

fileio.chown⁷⁺

fileio.chownSync⁷⁺

fileio.mkdtemp⁷⁺

fileio.mkdtemp⁷⁺

fileio.mkdtempSync⁷⁺

fileio.fchmod⁷⁺

fileio.fchmod⁷⁺

fileio.fchmodSync⁷⁺

fileio.createStream⁷⁺

fileio.createStream⁷⁺

fileio.createStreamSync⁷⁺

fileio.fdopenStream⁷⁺

fileio.fdopenStream⁷⁺

fileio.fdopenStreamSync⁷⁺

fileio.fchown⁷⁺

fileio.fchown⁷⁺

fileio.fchownSync⁷⁺

fileio.lchown⁷⁺

fileio.lchown⁷⁺

fileio.lchownSync⁷⁺

fileio.createWatcher⁷⁺

Watcher⁷⁺

stop⁷⁺

stop⁷⁺

close⁷⁺

close⁷⁺

flush⁷⁺

flush⁷⁺

flushSync⁷⁺

write⁷⁺

write⁷⁺

writeSync⁷⁺

read⁷⁺

read⁷⁺

readSync⁷⁺

close⁷⁺

close⁷⁺