文件管理

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

说明： 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 开发前请熟悉鸿蒙开发指导文档 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

导入模块

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

参数：

返回值：

示例：

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

参数：

示例：

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

fileio.statSync

statSync(path:string): Stat

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

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

参数：

返回值：

示例：

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

fileio.opendir

opendir(path: string): Promise

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

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

参数：

返回值：

示例：

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

参数：

示例：

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

参数：

返回值：

示例：

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

参数：

返回值：

示例：

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

参数：

示例：

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

fileio.accessSync

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

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

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

参数：

示例：

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

fileio.close7+

close(fd: number):Promise

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

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

参数：

返回值：

示例：

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

参数：

示例：

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

fileio.closeSync

closeSync(fd: number): void

以同步方法关闭文件。

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

参数：

示例：

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

参数：

返回值：

示例：

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

参数：

示例：

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

参数：

示例：

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

fileio.mkdir

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

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

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

参数：

返回值：

示例：

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

参数：

示例：

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

fileio.mkdirSync

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

以同步方法创建目录。

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

参数：

示例：

fileio.mkdirSync(path);

fileio.open7+

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

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

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

参数：

返回值：

示例：

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

参数：

示例：

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

fileio.openSync

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

以同步方法打开文件。

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

参数：

返回值：

示例：

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

参数：

返回值：

示例：

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

参数：

示例：

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

参数：

返回值：

示例：

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

参数：

返回值：

示例：

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

参数：

示例：

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

fileio.rmdirSync7+

rmdirSync(path: string): void

以同步方法删除目录。

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

参数：

示例：

fileio.rmdirSync(path);

fileio.unlink

unlink(path:string): Promise

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

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

参数：

返回值：

示例：

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

参数：

示例：

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

fileio.unlinkSync

unlinkSync(path: string): void

以同步方法删除文件。

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

参数：

示例：

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

参数：

返回值：

示例：

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

参数：

示例：

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

参数：

返回值：

示例：

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

参数：

返回值：

示例：

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

参数：

示例：

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

参数：

返回值：

示例：

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

参数：

示例：

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

fileio.chmodSync7+

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

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

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

参数：

示例：

fileio.chmodSync(path, 0o700);

fileio.fstat7+

fstat(fd: number): Promise

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

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

参数：

返回值：

示例：

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

参数：

示例：

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

fileio.fstatSync7+

fstatSync(fd: number): Stat

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

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

参数：

返回值：

示例：

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

fileio.ftruncate7+

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

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

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

参数：

返回值：

示例：

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

参数：

示例：

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

参数：

示例：

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

参数：

返回值：

示例：

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

参数：

示例：

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

fileio.truncateSync7+

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

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

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

参数：

示例：

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

参数：

返回值：

示例：

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

参数：

示例：

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

参数：

返回值：

示例：

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

fileio.lstat7+

lstat(path: string): Promise

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

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

参数：

返回值：

示例：

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

参数：

示例：

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

fileio.lstatSync7+

lstatSync(path:string): Stat

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

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

参数：

返回值：

示例：

let stat = fileio.lstatSync(path);

fileio.rename7+

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

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

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

参数：

返回值：

示例：

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

参数：

示例：

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

参数：

示例：

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

fileio.fsync7+

fsync(fd: number): Promise

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

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

参数：

返回值：

示例：

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

参数：

示例：

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

fileio.fsyncSync7+

fsyncSync(fd: number): void

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

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

参数：

示例：

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

fileio.fdatasync7+

fdatasync(fd: number): Promise

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

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

参数：

返回值：

示例：

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

参数：

示例：

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

fileio.fdatasyncSync7+

fdatasyncSync(fd: number): void

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

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

参数：

示例：

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

fileio.symlink7+

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

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

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

参数：

返回值：

示例：

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

参数：

示例：

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

参数：

示例：

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

参数：

返回值：

示例：

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

参数：

示例：

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

参数：

示例：

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

fileio.mkdtemp7+

mkdtemp(prefix: string): Promise

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

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

参数：

返回值：

示例：

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

参数：

示例：

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

fileio.mkdtempSync7+

mkdtempSync(prefix: string): string

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

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

参数：

返回值：

示例：

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

fileio.fchmod7+

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

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

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

参数：

返回值：

示例：

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

参数：

示例：

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

参数：

示例：

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

参数：

返回值：

示例：

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

参数：

示例：

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

fileio.createStreamSync7+

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

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

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

参数：

返回值：

示例：

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

fileio.fdopenStream7+

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

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

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

参数：

返回值：

示例：

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

参数：

示例：

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

参数：

返回值：

示例：

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

参数：

返回值：

示例：

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

参数：

示例：

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

参数：

示例：

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

参数：

返回值：

示例：

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

参数：

示例：

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

参数：

示例：

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

参数：

返回值：

示例：

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

Readout

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

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

Stat

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

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

属性

isBlockDevice

isBlockDevice(): boolean

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

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

返回值：

示例：

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

isCharacterDevice

isCharacterDevice(): boolean

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

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

返回值：

示例：

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

isDirectory

isDirectory(): boolean

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

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

返回值：

示例：

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

isFIFO

isFIFO(): boolean

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

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

返回值：

示例：

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

isFile

isFile(): boolean

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

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

返回值：

示例：

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

isSocket

isSocket(): boolean

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

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

返回值：

示例：

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

isSymbolicLink

isSymbolicLink(): boolean

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

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

返回值：

示例：

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

参数：

示例：

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

返回值：

示例：

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

参数：

示例：

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

返回值：

示例：

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

参数：

示例：

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

参数：

返回值：

示例：

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

参数：

示例：

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 something
       console.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

参数：

返回值：

示例：

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

参数：

返回值：

示例：

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

参数：

示例：

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

参数：

返回值：

示例：

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

返回值：

示例：

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

参数：

示例：

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

readSync

readSync(): Dirent

同步读取下一个目录项。

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

返回值：

示例：

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。

属性

isBlockDevice

isBlockDevice(): boolean

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

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

返回值：

示例：

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

isCharacterDevice

isCharacterDevice(): boolean

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

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

返回值：

示例：

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

isDirectory

isDirectory(): boolean

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

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

返回值：

示例：

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

isFIFO

isFIFO(): boolean

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

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

返回值：

示例：

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

isFile

isFile(): boolean

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

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

返回值：

示例：

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

isSocket

isSocket(): boolean

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

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

返回值：

示例：

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

isSymbolicLink

isSymbolicLink(): boolean

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

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

返回值：

示例：

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

审核编辑 黄宇