鸿蒙开发文件管理：【@ohos.fileio (文件管理)】

2024-06-12 01:52
文章标签 开发 管理 鸿蒙 ohos fileio

本文主要是介绍鸿蒙开发文件管理：【@ohos.fileio (文件管理)】，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

文件管理

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

icon-note.gif 说明：  本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import fileio from '@ohos.fileio';

使用说明

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

import featureAbility from '@ohos.ability.featureAbility';
let context = featureAbility.getContext();
let path = '';
context.getFilesDir().then((data) => {path = data;
})

fileio.stat

stat(path: string): Promise

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

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

参数：

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

返回值：

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

示例：

fileio.stat(path).then(function(stat){console.info("getFileInfo succeed:"+ JSON.stringify(stat));
}).catch(function(err){console.info("getFileInfo failed with error:"+ err);
});

fileio.stat

stat(path:string, callback:AsyncCallback): void

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

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

参数：

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

示例：

fileio.stat(path, function (err, stat) {// example code in Stat
});

fileio.statSync

statSync(path:string): Stat

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

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

参数：

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

返回值：

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

示例：

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

fileio.opendir

opendir(path: string): Promise

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

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

参数：

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

返回值：

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

示例：

fileio.opendir(path).then(function(dir){console.info("opendir succeed:"+ JSON.stringify(dir));
}).catch(function(err){console.info("opendir failed with error:"+ err);
});

fileio.opendir

opendir(path: string, callback: AsyncCallback

): void

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

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

参数：

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

示例：

fileio.opendir(path, function (err, dir) { // example code in Dir struct// use read/readSync/close
});

fileio.opendirSync

opendirSync(path: string): Dir

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

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

参数：

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

返回值：

类型说明
[Dir]返回Dir对象。

示例：

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

fileio.access

access(path: string, mode?: number): Promise

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

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

参数：

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

返回值：

类型说明
PromisePromise对象。无返回值。

示例：

fileio.access(path).then(function() {console.info("access succeed");
}).catch(function(err){console.info("access failed with error:"+ err);
});

fileio.access

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

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

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

参数：

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

示例：

fileio.access(path, function (err) {// do something
});

fileio.accessSync

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

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

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

参数：

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

示例：

try {fileio.accessSync(path);
} catch(err) {console.info("accessSync failed with error:"+ err);
}

fileio.close7+

close(fd: number):Promise

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

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

参数：

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

返回值：

类型说明
PromisePromise对象。无返回值。

示例：

let fd = fileio.openSync(path);
fileio.close(fd).then(function(){console.info("close file succeed");
}).catch(function(err){console.info("close file failed with error:"+ err);
});

fileio.close7+

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

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

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

参数：

参数名类型必填说明
fdnumber是待关闭文件的文件描述符。
callbackAsyncCallback是异步关闭文件之后的回调。

示例：

let fd = fileio.openSync(path);
fileio.close(fd, function (err) {// do something
});

fileio.closeSync

closeSync(fd: number): void

以同步方法关闭文件。

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

参数：

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

示例：

let fd = fileio.openSync(path);
fileio.closeSync(fd);

fileio.copyFile

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

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

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

参数：

参数名类型必填说明
srcstringnumber是
deststringnumber是
modenumber否mode提供覆盖文件的选项，当前仅支持0，且默认为0。 0：完全覆盖目标文件，未覆盖部分将被裁切掉。

返回值：

类型说明
PromisePromise对象。无返回值。

示例：

let src = path;
let dest = src + 'tgt';
fileio.copyFile(src, dest).then(function(){console.info("copyFile succeed");
}).catch(function(err){console.info("copyFile failed with error:"+ err);
});

fileio.copyFile

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

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

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

参数：

参数名类型必填说明
srcstringnumber是
deststringnumber是
modenumber否mode提供覆盖文件的选项，当前仅支持0，且默认为0。 0：完全覆盖目标文件，未覆盖部分将被裁切掉。
callbackAsyncCallback是异步复制文件之后的回调。

示例：

let src = path;
let dest = src + 'tgt';
fileio.copyFile(src, dest, function (err) {// do something
});

fileio.copyFileSync

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

以同步方法复制文件。

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

参数：

参数名类型必填说明
srcstringnumber是
deststringnumber是
modenumber否mode提供覆盖文件的选项，当前仅支持0，且默认为0。 0：完全覆盖目标文件，未覆盖部分将被裁切掉。

示例：

let src = path;
let dest = src + 'tgt';
fileio.copyFileSync(src, dest);

fileio.mkdir

mkdir(path:string, mode?: number): Promise

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

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

参数：

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

返回值：

类型说明
PromisePromise对象。无返回值。

示例：

fileio.mkdir(path).then(function() {console.info("mkdir succeed");
}).catch(function (error){console.info("mkdir failed with error:"+ error);
});

fileio.mkdir

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

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

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

参数：

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

示例：

fileio.mkdir(path, function(err) {console.info("mkdir succeed");
});

fileio.mkdirSync

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

以同步方法创建目录。

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

参数：

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

示例：

fileio.mkdirSync(path);

fileio.open7+

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

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

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

参数：

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

返回值：

类型说明
PromisePromise对象。返回打开文件的文件描述符。

示例：

fileio.open(path, 0o1, 0o0200).then(function(number){console.info("open file succeed");
}).catch(function(err){console.info("open file failed with error:"+ err);
});

fileio.open7+

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

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

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

参数：

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

示例：

fileio.open(path, 0, function(err, fd) {// do something
});

fileio.openSync

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

以同步方法打开文件。

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

参数：

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

返回值：

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

示例：

let fd = fileio.openSync(path, 0o102, 0o640);

let fd = fileio.openSync(path, 0o102, 0o666);
fileio.writeSync(fd, 'hello world');
let fd1 = fileio.openSync(path, 0o2002);
fileio.writeSync(fd1, 'hello world');
let num = fileio.readSync(fd1, new ArrayBuffer(4096), {position: 0});
console.info("num == " + num);

fileio.read

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

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

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

参数：

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

返回值：

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

示例：

let fd = fileio.openSync(path, 0o2);
let buf = new ArrayBuffer(4096);
fileio.read(fd, buf).then(function(readOut){console.info("read file data succeed");console.log(String.fromCharCode.apply(null, new Uint8Array(readOut.buffer)));
}).catch(function(err){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): void

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

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

参数：

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

示例：

let fd = fileio.openSync(path, 0o2);
let buf = new ArrayBuffer(4096);
fileio.read(fd, buf, function (err, readOut) {if (readOut) {console.info("read file data succeed");console.log(String.fromCharCode.apply(null, new Uint8Array(readOut.buffer)));}
});

fileio.readSync

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

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

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

参数：

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

返回值：

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

示例：

let fd = fileio.openSync(path, 0o2);
let buf = new ArrayBuffer(4096);
let num = fileio.readSync(fd, buf);

fileio.rmdir7+

rmdir(path: string): Promise

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

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

参数：

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

返回值：

类型说明
PromisePromise对象。无返回值。

示例：

fileio.rmdir(path).then(function() {console.info("rmdir succeed");
}).catch(function(err){console.info("rmdir failed with error:"+ err);
});

fileio.rmdir7+

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

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

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

参数：

参数名类型必填说明
pathstring是待删除目录的应用沙箱路径。
callbackAsyncCallback是异步删除目录之后的回调。

示例：

fileio.rmdir(path, function(err){// do somethingconsole.info("rmdir succeed");
});

fileio.rmdirSync7+

rmdirSync(path: string): void

以同步方法删除目录。

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

参数：

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

示例：

fileio.rmdirSync(path);

fileio.unlink

unlink(path:string): Promise

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

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

参数：

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

返回值：

类型说明
PromisePromise对象。无返回值。

示例：

fileio.unlink(path).then(function(){console.info("remove file succeed");
}).catch(function(error){console.info("remove file failed with error:"+ error);
});

fileio.unlink

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

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

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

参数：

参数名类型必填说明
pathstring是待删除文件的应用沙箱路径。
callbackAsyncCallback是异步删除文件之后的回调。

示例：

fileio.unlink(path, function(err) {console.info("remove file succeed");
});

fileio.unlinkSync

unlinkSync(path: string): void

以同步方法删除文件。

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

参数：

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

示例：

fileio.unlinkSync(path);

fileio.write

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

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

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

参数：

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

返回值：

类型说明
PromisePromise对象。返回实际写入的长度。

示例：

let fd = fileio.openSync(path, 0o100 | 0o2, 0o666);
fileio.write(fd, "hello, world").then(function(number){console.info("write data to file succeed and size is:"+ number);
}).catch(function(err){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): void

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

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

参数：

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

示例：

let fd = fileio.openSync(path, 0o100 | 0o2, 0o666);
fileio.write(fd, "hello, world", function (err, bytesWritten) {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

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

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

参数：

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

返回值：

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

示例：

let fd = fileio.openSync(path, 0o100 | 0o2, 0o666);
let num = fileio.writeSync(fd, "hello, world");

fileio.hash

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

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

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

参数：

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

返回值：

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

示例：

fileio.hash(path, "sha256").then(function(str){console.info("calculate file hash succeed:"+ str);
}).catch(function(err){console.info("calculate file hash failed with error:"+ err);
});

fileio.hash

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

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

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

参数：

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

示例：

fileio.hash(path, "sha256", function(err, hashStr) {if (hashStr) {console.info("calculate file hash succeed:"+ hashStr);}
});

fileio.chmod7+

chmod(path: string, mode: number):Promise

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

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

参数：

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

返回值：

类型说明
PromisePromise对象。无返回值。

示例：

fileio.chmod(path, 0o700).then(function() {console.info("chmod succeed");
}).catch(function(err){console.info("chmod failed with error:"+ err);
});

fileio.chmod7+

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

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

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

参数：

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

示例：

fileio.chmod(path, 0o700, function (err) {// do something
});

fileio.chmodSync7+

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

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

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

参数：

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

示例：

fileio.chmodSync(path, 0o700);

fileio.fstat7+

fstat(fd: number): Promise

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

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

参数：

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

返回值：

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

示例：

let fd = fileio.openSync(path);
fileio.fstat(fd).then(function(stat){console.info("fstat succeed:"+ JSON.stringify(stat));
}).catch(function(err){console.info("fstat failed with error:"+ err);
});

fileio.fstat7+

fstat(fd: number, callback: AsyncCallback): void

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

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

参数：

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

示例：

let fd = fileio.openSync(path);
fileio.fstat(fd, function (err) {// do something
});

fileio.fstatSync7+

fstatSync(fd: number): Stat

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

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

参数：

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

返回值：

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

示例：

let fd = fileio.openSync(path);
let stat = fileio.fstatSync(fd);

fileio.ftruncate7+

ftruncate(fd: number, len?: number): Promise

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

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

参数：

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

返回值：

类型说明
PromisePromise对象。无返回值。

示例：

let fd = fileio.openSync(path);
fileio.ftruncate(fd, 5).then(function(err) {    console.info("truncate file succeed");
}).catch(function(err){console.info("truncate file failed with error:"+ err);
});

fileio.ftruncate7+

ftruncate(fd: number, len: number, callback:AsyncCallback): void

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

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

参数：

参数名类型必填说明
fdnumber是待截断文件的文件描述符。
lennumber是文件截断后的长度，以字节为单位。
callbackAsyncCallback是回调函数，本调用无返回值。

示例：

let fd = fileio.openSync(path);
let len = 5;
fileio.ftruncate(fd, 5, function(err){// do something
});

fileio.ftruncateSync7+

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

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

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

参数：

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

示例：

let fd = fileio.openSync(path);
let len = 5;
fileio.ftruncateSync(fd, len);

fileio.truncate7+

truncate(path: string, len?: number): Promise

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

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

参数：

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

返回值：

类型说明
PromisePromise对象。无返回值。

示例：

let len = 5;
fileio.truncate(path, len).then(function(){console.info("truncate file succeed");
}).catch(function(err){console.info("truncate file failed with error:"+ err);
});

fileio.truncate7+

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

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

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

参数：

参数名类型必填说明
pathstring是待截断文件的应用沙箱路径。
lennumber是文件截断后的长度，以字节为单位。
callbackAsyncCallback是回调函数，本调用无返回值。

示例：

let len = 5;
fileio.truncate(path, len, function(err){// do something
});

fileio.truncateSync7+

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

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

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

参数：

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

示例：

let len = 5;
fileio.truncateSync(path, len);

fileio.readText7+

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

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

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

参数：

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

返回值：

类型说明
PromisePromise对象。返回读取文件的内容。

示例：

fileio.readText(path).then(function(str) {console.info("readText succeed:"+ str);
}).catch(function(err){console.info("readText failed with error:"+ err);
});

fileio.readText7+

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

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

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

参数：

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

示例：

fileio.readText(path, { position: 1, encoding: 'UTF-8' }, function(err, str){// do something
});

fileio.readTextSync7+

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

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

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

参数：

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

返回值：

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

示例：

let str = fileio.readTextSync(path, {position: 1, length: 3});

fileio.lstat7+

lstat(path: string): Promise

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

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

参数：

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

返回值：

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

示例：

fileio.lstat(path).then(function(stat){console.info("get link status succeed:"+ JSON.stringify(stat));
}).catch(function(err){console.info("get link status failed with error:"+ err);
});

fileio.lstat7+

lstat(path:string, callback:AsyncCallback): void

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

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

参数：

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

示例：

fileio.lstat(path, function (err, stat) {// do something
});

fileio.lstatSync7+

lstatSync(path:string): Stat

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

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

参数：

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

返回值：

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

示例：

let stat = fileio.lstatSync(path);

fileio.rename7+

rename(oldPath: string, newPath: string): Promise

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

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

参数：

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

返回值：

类型说明
PromisePromise对象。无返回值。

示例：

let oldPath = path;
let newPath = oldPath + '123';
fileio.rename(oldPath, newPath).then(function() {console.info("rename succeed");
}).catch(function(err){console.info("rename failed with error:"+ err);
});

fileio.rename7+

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

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

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

参数：

参数名类型必填说明
oldPathstring是目标文件的当前应用沙箱路径。
newPathString是目标文件的新应用沙箱路径。
CallbackAsyncCallback是异步重命名文件之后的回调。

示例：

let oldPath = path;
let newPath = oldPath + '123';
fileio.rename(oldPath, newPath, function(err){
});

fileio.renameSync7+

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

以同步方法重命名文件。

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

参数：

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

示例：

let oldPath = path;
let newPath = oldPath + '123';
fileio.renameSync(oldPath, newPath);

fileio.fsync7+

fsync(fd: number): Promise

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

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

参数：

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

返回值：

类型说明
PromisePromise对象。无返回值。

示例：

let fd = fileio.openSync(path);
fileio.fsync(fd).then(function(){console.info("sync data succeed");
}).catch(function(err){console.info("sync data failed with error:"+ err);
});

fileio.fsync7+

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

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

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

参数：

参数名类型必填说明
fdnumber是待同步文件的文件描述符。
CallbackAsyncCallback是异步将文件数据同步之后的回调。

示例：

let fd = fileio.openSync(path);
fileio.fsync(fd, function(err){// do something
});

fileio.fsyncSync7+

fsyncSync(fd: number): void

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

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

参数：

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

示例：

let fd = fileio.openSync(path);
fileio.fsyncSync(fd);

fileio.fdatasync7+

fdatasync(fd: number): Promise

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

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

参数：

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

返回值：

类型说明
PromisePromise对象。无返回值。

示例：

let fd = fileio.openSync(path);
fileio.fdatasync(fd).then(function(err) {console.info("sync data succeed");
}).catch(function(err){console.info("sync data failed with error:"+ err);
});

fileio.fdatasync7+

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

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

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

参数：

参数名类型必填说明
fdnumber是待同步文件的文件描述符。
callbackAsyncCallback 是异步将文件内容数据同步之后的回调。

示例：

let fd = fileio.openSync(path);
fileio.fdatasync (fd, function (err) {// do something
});

fileio.fdatasyncSync7+

fdatasyncSync(fd: number): void

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

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

参数：

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

示例：

let fd = fileio.openSync(path);
let stat = fileio.fdatasyncSync(fd);

fileio.symlink7+

symlink(target: string, srcPath: string): Promise

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

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

参数：

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

返回值：

类型说明
PromisePromise对象。无返回值。

示例：

let target = path;
let srcPath = target + 'aaa';
fileio.symlink(target, srcPath).then(function() {console.info("symlink succeed");
}).catch(function(err){console.info("symlink failed with error:"+ err);
});

fileio.symlink7+

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

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

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

参数：

参数名类型必填说明
targetstring是目标文件的应用沙箱路径。
srcPathstring是符号链接文件的应用沙箱路径。
callbackAsyncCallback是异步创建符号链接信息之后的回调。

示例：

let target = path;
let srcPath = target + 'aaa';
fileio.symlink(target, srcPath, function (err) {// do something
});

fileio.symlinkSync7+

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

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

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

参数：

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

示例：

let target = path;
let srcPath = target + 'aaa';
fileio.symlinkSync(target, srcPath);

fileio.chown7+

chown(path: string, uid: number, gid: number): Promise

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

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

参数：

参数名类型必填说明
pathstring是待改变文件的应用沙箱路径。
uidnumber是新的UID（UserID）。
gidnumber是新的GID（GroupID）。

返回值：

类型说明
PromisePromise对象。无返回值。

示例：

let stat = fileio.statSync(path);
fileio.chown(path, stat.uid, stat.gid).then(function(){console.info("chown succeed");
}).catch(function(err){console.info("chown failed with error:"+ err);
});

fileio.chown7+

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

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

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

参数：

参数名类型必填说明
pathstring是待改变文件的应用沙箱路径。
uidnumber是新的UID。
gidnumber是新的GID。
callbackAsyncCallback是异步改变文件所有者之后的回调。

示例：

let stat = fileio.statSync(path)
fileio.chown(path, stat.uid, stat.gid, function (err){// do something
});

fileio.chownSync7+

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

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

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

参数：

参数名类型必填说明
pathstring是待改变文件的应用沙箱路径。
uidnumber是新的UID。
gidnumber是新的GID。

示例：

let stat = fileio.statSync(path)
fileio.chownSync(path, stat.uid, stat.gid);

fileio.mkdtemp7+

mkdtemp(prefix: string): Promise

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

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

参数：

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

返回值：

类型说明
PromisePromise对象。返回生成的唯一目录路径。

示例：

fileio.mkdtemp(path + "XXXX").then(function(path){console.info("mkdtemp succeed:"+ path);
}).catch(function(err){console.info("mkdtemp failed with error:"+ err);
});

fileio.mkdtemp7+

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

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

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

参数：

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

示例：

fileio.mkdtemp(path + "XXXX", function (err, res) {// do something
});

fileio.mkdtempSync7+

mkdtempSync(prefix: string): string

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

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

参数：

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

返回值：

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

示例：

let res = fileio.mkdtempSync(path + "XXXX");

fileio.fchmod7+

fchmod(fd: number, mode: number): Promise

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

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

参数：

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

返回值：

类型说明
PromisePromise对象。无返回值。

示例：

let fd = fileio.openSync(path);
let mode = 0o700;
fileio.fchmod(fd, mode).then(function() {console.info("chmod succeed");
}).catch(function(err){console.info("chmod failed with error:"+ err);
});

fileio.fchmod7+

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

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

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

参数：

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

示例：

let fd = fileio.openSync(path);
let mode = 0o700;
fileio.fchmod(fd, mode, function (err) {// do something
});

fileio.fchmodSync7+

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

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

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

参数：

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

示例：

let fd = fileio.openSync(path);
let mode = 0o700;fileio.fchmodSync(fd, mode);

fileio.createStream7+

createStream(path: string, mode: string): Promise

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

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

参数：

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

返回值：

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

示例：

fileio.createStream(path, "r+").then(function(stream){console.info("createStream succeed");
}).catch(function(err){console.info("createStream failed with error:"+ err);
});

fileio.createStream7+

createStream(path: string, mode: string, callback: AsyncCallback): void

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

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

参数：

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

示例：

fileio.createStream(path, "r+", function(err, stream){// do something
});

fileio.createStreamSync7+

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

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

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

参数：

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

返回值：

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

示例：

let ss = fileio.createStreamSync(path, "r+");

fileio.fdopenStream7+

fdopenStream(fd: number, mode: string): Promise

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

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

参数：

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

返回值：

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

示例：

let fd = fileio.openSync(path);
fileio.fdopenStream(fd, "r+").then(function(stream){console.info("openStream succeed");
}).catch(function(err){console.info("openStream failed with error:"+ err);
});

fileio.fdopenStream7+

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

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

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

参数：

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

示例：

let fd = fileio.openSync(path);
fileio.fdopenStream(fd, "r+", function (err, stream) {// do something
});

fileio.fdopenStreamSync7+

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

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

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

参数：

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

返回值：

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

示例：

let fd = fileio.openSync(path);
let ss = fileio.fdopenStreamSync(fd, "r+");

fileio.fchown7+

fchown(fd: number, uid: number, gid: number): Promise

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

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

参数：

参数名类型必填说明
fdnumber是待改变文件的文件描述符。
uidnumber是文件所有者的UID。
gidnumber是文件所有组的GID。

返回值：

类型说明
PromisePromise对象。无返回值。

示例：

let fd = fileio.openSync(path);
let stat = fileio.statSync(path);
fileio.fchown(fd, stat.uid, stat.gid).then(function() {console.info("chown succeed");
}).catch(function(err){console.info("chown failed with error:"+ err);
});

fileio.fchown7+

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

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

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

参数：

参数名类型必填说明
fdnumber是待改变文件的文件描述符。
uidnumber是文件所有者的UID。
gidnumber是文件所有组的GID。
callbackAsyncCallback是异步改变文件所有者之后的回调。

示例：

let fd = fileio.openSync(path);
let stat = fileio.statSync(path);
fileio.fchown(fd, stat.uid, stat.gid, function (err){// do something
});

fileio.fchownSync7+

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

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

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

参数：

参数名类型必填说明
fdnumber是待改变文件的文件描述符。
uidnumber是文件所有者的UID。
gidnumber是文件所有组的GID。

示例：

let fd = fileio.openSync(path);
let stat = fileio.statSync(path);
fileio.fchownSync(fd, stat.uid, stat.gid);

fileio.lchown7+

lchown(path: string, uid: number, gid: number): Promise

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

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

参数：

参数名类型必填说明
pathstring是待打开文件的应用沙箱路径。
uidnumber是新的UID。
gidnumber是新的GID。

返回值：

类型说明
PromisePromise对象。无返回值。

示例：

let stat = fileio.statSync(path);
fileio.lchown(path, stat.uid, stat.gid).then(function() {console.info("chown succeed");
}).catch(function(err){console.info("chown failed with error:"+ err);
});

fileio.lchown7+

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

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

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

参数：

参数名类型必填说明
pathstring是待打开文件的应用沙箱路径。
uidnumber是新的UID。
gidnumber是新的GID。
callbackAsyncCallback是异步改变文件所有者之后的回调。

示例：

let stat = fileio.statSync(path);
fileio.lchown(path, stat.uid, stat.gid, function (err){// do something
});

fileio.lchownSync7+

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

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

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

参数：

参数名类型必填说明
pathstring是待打开文件的应用沙箱路径。
uidnumber是新的UID。
gidnumber是新的GID。

示例：

let stat = fileio.statSync(path);
fileio.lchownSync(path, stat.uid, stat.gid);

fileio.createWatcher7+

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

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

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

参数：

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

返回值：

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

示例：

let filename = path +"/test.txt";
fileio.createWatcher(filename, 1, function(number){console.info("Monitoring times: "+number);
});

Readout

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

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

名称参数类型可读可写说明
bytesReadnumber是是实际读取长度。
offsetnumber是是读取数据相对于缓冲区首地址的偏移。
bufferArrayBufer是是保存读取数据的缓冲区。

Stat

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

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

属性

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

isBlockDevice

isBlockDevice(): boolean

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

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

返回值：

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

示例：

let isBLockDevice = fileio.statSync(path).isBlockDevice();

isCharacterDevice

isCharacterDevice(): boolean

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

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

返回值：

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

示例：

let isCharacterDevice = fileio.statSync(path).isCharacterDevice();

isDirectory

isDirectory(): boolean

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

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

返回值：

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

示例：

let isDirectory = fileio.statSync(path).isDirectory();

isFIFO

isFIFO(): boolean

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

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

返回值：

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

示例：

let isFIFO = fileio.statSync(path).isFIFO();

isFile

isFile(): boolean

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

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

返回值：

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

示例：

let isFile = fileio.statSync(path).isFile();

isSocket

isSocket(): boolean

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

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

返回值：

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

示例：

let isSocket = fileio.statSync(path).isSocket();

isSymbolicLink

isSymbolicLink(): boolean

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

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

返回值：

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

示例：

let isSymbolicLink = fileio.statSync(path).isSymbolicLink();

Watcher7+

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

stop7+

stop(): Promise

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

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

示例：

let filename = path +"/test.txt";
let watcher = fileio.createWatcher(filename, 1, function(number){console.info("Monitoring times: "+number);
});
watcher.stop().then(function(){console.info("close watcher succeed");
});

stop7+

stop(callback: AsyncCallback): void

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

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

参数：

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

示例：

let filename = path +"/test.txt";
let watcher = fileio.createWatcher(filename, 1, function(number){console.info("Monitoring times: "+number);
});
watcher.stop(function(){console.info("close watcher succeed");
})

Stream

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

close7+

close(): Promise

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

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

返回值：

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

示例：

let ss= fileio.createStreamSync(path, "r+");
ss.close().then(function(){console.info("close fileStream succeed");
}).catch(function(err){console.info("close fileStream  failed with error:"+ err);
});

close7+

close(callback: AsyncCallback): void

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

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

参数：

参数名类型必填说明
callbackAsyncCallback是异步关闭文件流之后的回调。

示例：

let ss= fileio.createStreamSync(path, "r+");
ss.close(function (err) {// do something
});

closeSync

closeSync(): void

同步关闭文件流。

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

示例：

let ss= fileio.createStreamSync(path, "r+");
ss.closeSync();

flush7+

flush(): Promise

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

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

返回值：

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

示例：

let ss= fileio.createStreamSync(path, "r+");
ss.flush().then(function (){console.info("flush succeed");
}).catch(function(err){console.info("flush failed with error:"+ err);
});

flush7+

flush(callback: AsyncCallback): void

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

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

参数：

参数名类型必填说明
callbackAsyncCallback是异步刷新文件流后的回调函数。

示例：

let ss= fileio.createStreamSync(path, "r+");
ss.flush(function (err) {// do something
});

flushSync7+

flushSync(): void

同步刷新文件流。

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

示例：

let ss= fileio.createStreamSync(path, "r+");
ss.flushSync();

write7+

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

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

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

参数：

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

返回值：

类型说明
PromisePromise对象。返回实际写入的长度。

示例：

let ss= fileio.createStreamSync(path, "r+");
ss.write("hello, world",{offset: 1,length: 5,position: 5,encoding :'utf-8'}).then(function (number){console.info("write succeed and size is:"+ number);
}).catch(function(err){console.info("write failed with error:"+ err);
});

write7+

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

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

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

参数：

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

示例：

let ss= fileio.createStreamSync(path, "r+");
ss.write("hello, world", {offset: 1, length: 5, position: 5, encoding :'utf-8'}, function (err, bytesWritten) {if (bytesWritten) {// do somethingconsole.info("write succeed and size is:"+ bytesWritten);}
});

writeSync7+

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

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

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

参数：

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

返回值：

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

示例：

let ss= fileio.createStreamSync(path,"r+");
let num = ss.writeSync("hello, world", {offset: 1, length: 5, position: 5, encoding :'utf-8'});

read7+

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

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

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

参数：

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

返回值：

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

示例：

let ss = fileio.createStreamSync(path, "r+");
ss.read(new ArrayBuffer(4096), {offset: 1, length: 5, position: 5}).then(function (readOut){console.info("read data succeed");console.log(String.fromCharCode.apply(null, new Uint8Array(readOut.buffer)));
}).catch(function(err){console.info("read data failed with error:"+ err);
});

read7+

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

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

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

参数：

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

示例：

let ss = fileio.createStreamSync(path, "r+");
ss.read(new ArrayBuffer(4096),{offset: 1, length: 5, position: 5},function (err, readOut) {if (readOut) {console.info("read data succeed");console.log(String.fromCharCode.apply(null, new Uint8Array(readOut.buffer)));}
});

readSync7+

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

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

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

参数：

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

返回值：

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

示例：

let ss = fileio.createStreamSync(path, "r+");
let num = ss.readSync(new ArrayBuffer(4096), {offset: 1, length: 5, position: 5});

Dir

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

read

read(): Promise

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

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

返回值：

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

示例：

dir.read().then(function (dirent){console.log("read succeed:"+JSON.stringify(dirent));
}).catch(function(err){console.info("read failed with error:"+ err);
});

read

read(callback: AsyncCallback): void

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

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

参数：

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

示例：

dir.read(function (err, dirent) {if (dirent) {// do somethingconsole.log("read succeed:"+JSON.stringify(dirent));}
});

readSync

readSync(): Dirent

同步读取下一个目录项。

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

返回值：

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

示例：

let dirent = dir.readSync();

close7+

close(): Promise

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

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

示例：

dir.close().then(function(err){console.info("close dir successfully");
});

close7+

close(callback: AsyncCallback): void

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

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

示例：

dir.close(function(err){console.info("close dir successfully");
});

closeSync

closeSync(): void

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

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

示例：

dir.closeSync();

Dirent

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

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

属性

名称参数类型可读可写说明
namestring是否目录项的名称。

isBlockDevice

isBlockDevice(): boolean

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

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

返回值：

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

示例：

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

isCharacterDevice

isCharacterDevice(): boolean

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

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

返回值：

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

示例：

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

isDirectory

isDirectory(): boolean

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

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

返回值：

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

示例：

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

isFIFO

isFIFO(): boolean

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

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

返回值：

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

示例：

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

isFile

isFile(): boolean

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

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

返回值：

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

示例：

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

isSocket

isSocket(): boolean

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

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

返回值：

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

示例：

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

isSymbolicLink

isSymbolicLink(): boolean

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

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

返回值：

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

示例：

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

这篇关于鸿蒙开发文件管理：【@ohos.fileio (文件管理)】的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1052868。

相关文章

这15个Vue指令，让你的项目开发爽到爆

这15个Vue指令，让你的项目开发爽到爆

1. V-Hotkey 仓库地址: github.com/Dafrok/v-ho… Demo: 戳这里 https://dafrok.github.io/v-hotkey 安装: npm install --save v-hotkey 这个指令可以给组件绑定一个或多个快捷键。你想要通过按下 Escape 键后隐藏某个组件，按住 Control 和回车键再显示它吗？小菜一碟： <template
阅读更多...
Hadoop企业开发案例调优场景

Hadoop企业开发案例调优场景

需求 （1）需求：从1G数据中，统计每个单词出现次数。服务器3台，每台配置4G内存，4核CPU，4线程。 （2）需求分析： 1G / 128m = 8个MapTask；1个ReduceTask；1个mrAppMaster 平均每个节点运行10个 / 3台 ≈ 3个任务（4    3    3） HDFS参数调优 （1）修改：hadoop-env.sh export HDFS_NAMENOD
阅读更多...
综合安防管理平台LntonAIServer视频监控汇聚抖动检测算法优势

综合安防管理平台LntonAIServer视频监控汇聚抖动检测算法优势

LntonAIServer视频质量诊断功能中的抖动检测是一个专门针对视频稳定性进行分析的功能。抖动通常是指视频帧之间的不必要运动，这种运动可能是由于摄像机的移动、传输中的错误或编解码问题导致的。抖动检测对于确保视频内容的平滑性和观看体验至关重要。 优势 1. 提高图像质量 - 清晰度提升：减少抖动，提高图像的清晰度和细节表现力，使得监控画面更加真实可信。 - 细节增强：在低光条件下，抖
阅读更多...
嵌入式QT开发：构建高效智能的嵌入式系统

嵌入式QT开发：构建高效智能的嵌入式系统

摘要： 本文深入探讨了嵌入式 QT 相关的各个方面。从 QT 框架的基础架构和核心概念出发，详细阐述了其在嵌入式环境中的优势与特点。文中分析了嵌入式 QT 的开发环境搭建过程，包括交叉编译工具链的配置等关键步骤。进一步探讨了嵌入式 QT 的界面设计与开发，涵盖了从基本控件的使用到复杂界面布局的构建。同时也深入研究了信号与槽机制在嵌入式系统中的应用，以及嵌入式 QT 与硬件设备的交互，包括输入输出设
阅读更多...
OpenHarmony鸿蒙开发（ Beta5.0）无感配网详解

OpenHarmony鸿蒙开发（ Beta5.0）无感配网详解

1、简介 无感配网是指在设备联网过程中无需输入热点相关账号信息，即可快速实现设备配网，是一种兼顾高效性、可靠性和安全性的配网方式。 2、配网原理 2.1 通信原理 手机和智能设备之间的信息传递，利用特有的NAN协议实现。利用手机和智能设备之间的WiFi 感知订阅、发布能力，实现了数字管家应用和设备之间的发现。在完成设备间的认证和响应后，即可发送相关配网数据。同时还支持与常规Sof
阅读更多...
活用c4d官方开发文档查询代码

活用c4d官方开发文档查询代码

当你问AI助手比如豆包，如何用python禁止掉xpresso标签时候，它会提示到 这时候要用到两个东西。https://developers.maxon.net/论坛搜索和开发文档 比如这里我就在官方找到正确的id描述 然后我就把参数标签换过来
阅读更多...
软考系统规划与管理师考试证书含金量高吗？

软考系统规划与管理师考试证书含金量高吗？

2024年软考系统规划与管理师考试报名时间节点： 报名时间：2024年上半年软考将于3月中旬陆续开始报名 考试时间：上半年5月25日到28日，下半年11月9日到12日 分数线：所有科目成绩均须达到45分以上（包括45分）方可通过考试 成绩查询：可在“中国计算机技术职业资格网”上查询软考成绩 出成绩时间：预计在11月左右 证书领取时间：一般在考试成绩公布后3~4个月，各地领取时间有所不同
阅读更多...
安全管理体系化的智慧油站开源了。

安全管理体系化的智慧油站开源了。

AI视频监控平台简介 AI视频监控平台是一款功能强大且简单易用的实时算法视频监控系统。它的愿景是最底层打通各大芯片厂商相互间的壁垒，省去繁琐重复的适配流程，实现芯片、算法、应用的全流程组合，从而大大减少企业级应用约95%的开发成本。用户只需在界面上进行简单的操作，就可以实现全视频的接入及布控。摄像头管理模块用于多种终端设备、智能设备的接入及管理。平台支持包括摄像头等终端感知设备接入，为整个平台提
阅读更多...
Linux_kernel驱动开发11

Linux_kernel驱动开发11

一、改回nfs方式挂载根文件系统         在产品将要上线之前，需要制作不同类型格式的根文件系统         在产品研发阶段，我们还是需要使用nfs的方式挂载根文件系统         优点：可以直接在上位机中修改文件系统内容，延长EMMC的寿命         【1】重启上位机nfs服务         sudo service nfs-kernel-server resta
阅读更多...
【区块链 + 人才服务】区块链集成开发平台 | FISCO BCOS应用案例

【区块链 + 人才服务】区块链集成开发平台 | FISCO BCOS应用案例

随着区块链技术的快速发展，越来越多的企业开始将其应用于实际业务中。然而，区块链技术的专业性使得其集成开发成为一项挑战。针对此，广东中创智慧科技有限公司基于国产开源联盟链 FISCO BCOS 推出了区块链集成开发平台。该平台基于区块链技术，提供一套全面的区块链开发工具和开发环境，支持开发者快速开发和部署区块链应用。此外，该平台还可以提供一套全面的区块链开发教程和文档，帮助开发者快速上手区块链开发。
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2