Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
7b430a9f
D
Docs
项目概览
OpenHarmony
/
Docs
12 个月 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
7b430a9f
编写于
5月 11, 2022
作者:
Z
zhangxingxia
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update fileio api
Signed-off-by:
N
zhangxingxia
<
zhangxingxia1@huawei.com
>
上级
01a6add8
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
302 addition
and
302 deletion
+302
-302
zh-cn/application-dev/reference/apis/js-apis-fileio.md
zh-cn/application-dev/reference/apis/js-apis-fileio.md
+302
-302
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-fileio.md
浏览文件 @
7b430a9f
...
...
@@ -39,19 +39,19 @@ stat(path: string): Promise<Stat>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------- |
| path | string | 是 | 待获取文件的绝对路径。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ---------------------------- | ---------- |
| Promise
<
[Stat](#stat)
>
| 表示文件的具体信息。 |
-
**示例:**
**示例:**
```
js
fileio
.
stat
(
path
).
then
(
function
(
stat
){
console
.
info
(
"
getFileInfo successfully:
"
+
JSON
.
stringify
(
stat
));
...
...
@@ -69,13 +69,13 @@ stat(path:string, callback:AsyncCallback<Stat>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------- | ---- | --------------- |
| path | string | 是 | 待获取文件的绝对路径。 |
| callback | AsyncCallback
<
[Stat](#stat)
>
| 是 | 异步获取文件的信息之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
stat
(
path
,
function
(
err
,
stat
)
{
// example code in Stat
...
...
@@ -91,18 +91,18 @@ statSync(path:string): Stat
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------- |
| path | string | 是 | 待获取文件的绝对路径。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------- | ---------- |
|
[
Stat
](
#stat
)
| 表示文件的具体信息。 |
-
**示例:**
**示例:**
```
js
let
stat
=
fileio
.
statSync
(
path
);
// example code in Stat
...
...
@@ -117,17 +117,17 @@ opendir(path: string): Promise<Dir>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------- |
| path | string | 是 | 待打开文件目录的绝对路径。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| -------------------------- | -------- |
| Promise
<
[Dir](#dir)
>
| 返回Dir对象。 |
-
**示例:**
**示例:**
```
js
fileio
.
opendir
(
path
).
then
(
function
(
dir
){
console
.
info
(
"
opendir successfully:
"
+
JSON
.
stringify
(
dir
));
...
...
@@ -145,14 +145,14 @@ opendir(path: string, callback: AsyncCallback<Dir>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | ---- | -------------- |
| path | string | 是 | 待打开文件目录的绝对路径。 |
| callback | AsyncCallback
<
[Dir](#dir)
>
| 是 | 异步打开文件目录之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
opendir
(
path
,
function
(
err
,
dir
)
{
// example code in Dir struct
...
...
@@ -170,18 +170,18 @@ opendirSync(path: string): Dir
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------- |
| path | string | 是 | 待打开文件目录的绝对路径。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ----------- | -------- |
|
[
Dir
](
#dir
)
| 返回Dir对象。 |
-
**示例:**
**示例:**
```
js
let
dir
=
fileio
.
opendirSync
(
path
);
// example code in Dir struct
...
...
@@ -197,19 +197,19 @@ access(path: string, mode?: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待访问文件的绝对路径。 |
| mode | number | 否 | 访问文件时的选项,可给定如下选项,以按位或的方式使用多个选项,默认给定0。
<br/>
确认当前进程是否具有对应权限:
<br/>
-
0:确认文件是否存在。
<br/>
-
1:确认当前进程是否具有可执行权限。
<br/>
-
2:确认当前进程是否具有写权限。
<br/>
-
4:确认当前进程是否具有读权限。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果。本调用将返回空值。 |
-
**示例:**
**示例:**
```
js
fileio
.
access
(
path
).
then
(
function
()
{
console
.
info
(
"
access successfully
"
);
...
...
@@ -227,14 +227,14 @@ access(path: string, mode: number, callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------- |
| path | string | 是 | 待访问文件的绝对路径。 |
| mode | number | 否 | 访问文件时的选项,可给定如下选项,以按位或的方式使用多个选项,默认给定0。
<br/>
确认当前进程是否具有对应权限:
<br/>
-
0:确认文件是否存在。
<br/>
-
1:确认当前进程是否具有可执行权限。
<br/>
-
2:确认当前进程是否具有写权限。
<br/>
-
4:确认当前进程是否具有读权限。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步检查当前进程是否可访问某文件之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
access
(
path
,
function
(
err
)
{
// do something
...
...
@@ -250,13 +250,13 @@ accessSync(path: string, mode?: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待访问文件的绝对路径。 |
| mode | number | 否 | 访问文件时的选项,可给定如下选项,以按位或的方式使用多个选项,默认给定0。
<br/>
确认当前进程是否具有对应权限:
<br/>
-
0:确认文件是否存在。
<br/>
-
1:确认当前进程是否具有可执行权限。
<br/>
-
2:确认当前进程是否具有写权限。
<br/>
-
4:确认当前进程是否具有读权限。 |
-
**示例:**
**示例:**
```
js
try
{
fileio
.
accessSync
(
path
);
...
...
@@ -274,17 +274,17 @@ close(fd: number):Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待关闭文件的文件描述符。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果。本调用将返回空值。 |
-
**示例:**
**示例:**
```
js
let
fd
=
fileio
.
openSync
(
path
);
fileio
.
close
(
fd
).
then
(
function
(){
...
...
@@ -303,13 +303,13 @@ close(fd: number, callback:AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------ |
| fd | number | 是 | 待关闭文件的文件描述符。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步关闭文件之后的回调。 |
-
**示例:**
**示例:**
```
js
let
fd
=
fileio
.
openSync
(
path
);
fileio
.
close
(
fd
,
function
(
err
)
{
...
...
@@ -326,12 +326,12 @@ closeSync(fd: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待关闭文件的文件描述符。 |
-
**示例:**
**示例:**
```
js
fileio
.
closeSync
(
fd
);
```
...
...
@@ -345,12 +345,12 @@ close(): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果。本调用将返回空值。 |
-
**示例:**
**示例:**
```
js
fileio
.
close
().
then
(
function
(){
console
.
info
(
"
close file stream successfully
"
);
...
...
@@ -368,12 +368,12 @@ close(callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------- |
| callback | AsyncCallback
<
void
>
| 是 | 异步关闭文件流之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
close
(
function
(
err
){
// do something
...
...
@@ -389,19 +389,19 @@ copyFile(src:string | number, dest:string | number, mode?:number):Promise<voi
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | -------------------------- | ---- | ---------------------------------------- |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
<br/>
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果。本调用将返回空值。 |
-
**示例:**
**示例:**
```
js
fileio
.
copyFile
(
src
,
dest
).
then
(
function
(){
console
.
info
(
"
copyFile successfully
"
);
...
...
@@ -419,7 +419,7 @@ copyFile(src: string | number, dest: string | number, mode: number, callback: As
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ---------------------------------------- |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
...
...
@@ -427,7 +427,7 @@ copyFile(src: string | number, dest: string | number, mode: number, callback: As
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
<br/>
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步复制文件之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
copyFile
(
src
,
dest
,
function
(
err
)
{
// do something
...
...
@@ -443,14 +443,14 @@ copyFileSync(src: string | number, dest: string | number, mode?: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | -------------------------- | ---- | ---------------------------------------- |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
<br/>
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
-
**示例:**
**示例:**
```
js
fileio
.
copyFileSync
(
src
,
dest
);
```
...
...
@@ -464,18 +464,18 @@ mkdir(path:string, mode?: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待创建目录的绝对路径。 |
| mode | number | 否 | 创建目录的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o775。
<br/>
-
0o775:所有者具有读、写及可执行权限,其余用户具有读及可执行权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果。本调用将返回空值。 |
-
**示例:**
**示例:**
```
js
fileio
.
mkdir
(
path
).
then
(
function
()
{
console
.
info
(
"
mkdir successfully
"
);
...
...
@@ -493,14 +493,14 @@ mkdir(path: string, mode: number, callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------- |
| path | string | 是 | 待创建目录的绝对路径。 |
| mode | number | 否 | 创建目录的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o775。
<br/>
-
0o775:所有者具有读、写及可执行权限,其余用户具有读及可执行权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步创建目录操作完成之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
mkdir
(
path
,
function
(
err
)
{
console
.
info
(
"
mkdir successfully
"
);
...
...
@@ -516,13 +516,13 @@ mkdirSync(path: string, mode?: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待创建目录的绝对路径。 |
| mode | number | 否 | 创建目录的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o775。
<br/>
-
0o775:所有者具有读、写及可执行权限,其余用户具有读及可执行权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
-
**示例:**
**示例:**
```
js
fileio
.
mkdirSync
(
path
);
```
...
...
@@ -536,19 +536,19 @@ open(path: string, flags?: number, mode?: number): Promise<number>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待打开文件的绝对路径。 |
| flags | number | 否 | 打开文件的选项,必须指定如下选项中的一个,默认以只读方式打开:
<br/>
-
0o0:只读打开。
<br/>
-
0o1:只写打开。
<br/>
-
0o2:读写打开。
<br/>
同时,也可给定如下选项,以按位或的方式追加,默认不给定任何额外选项:
<br/>
-
0o100:若文件不存在,则创建文件。使用该选项时必须指定第三个参数
mode。
<br/>
-
0o200:如果追加了0o100选项,且文件已经存在,则出错。
<br/>
-
0o1000:如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。
<br/>
-
0o2000:以追加方式打开,后续写将追加到文件末尾。
<br/>
-
0o4000:如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续
IO
进行非阻塞操作。
<br/>
-
0o200000:如果path指向目录,则出错。
<br/>
-
0o400000:如果path指向符号链接,则出错。
<br/>
-
0o4010000:以同步IO的方式打开文件。 |
| mode | number | 否 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。
<br/>
-
0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| --------------------- | ----------- |
| Promise
<
number
>
| 打开文件的文件描述符。 |
-
**示例:**
**示例:**
```
js
fileio
.
open
(
path
,
0o1
,
0o0200
).
then
(
function
(
number
){
console
.
info
(
"
open file successfully
"
);
...
...
@@ -566,7 +566,7 @@ open(path: string, flags: number, mode: number, callback: AsyncCallback<numbe
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ---------------------------------------- |
| path | string | 是 | 待打开文件的绝对路径。 |
...
...
@@ -574,7 +574,7 @@ open(path: string, flags: number, mode: number, callback: AsyncCallback<numbe
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。
<br/>
-
0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步打开文件之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
open
(
path
,
0
,
function
(
err
,
fd
)
{
// do something
...
...
@@ -590,19 +590,19 @@ openSync(path:string, flags?:number, mode?:number): number
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待打开文件的绝对路径。 |
| flags | number | 否 | 打开文件的选项,必须指定如下选项中的一个,默认以只读方式打开:
<br/>
-
0o0:只读打开。
<br/>
-
0o1:只写打开。
<br/>
-
0o2:读写打开。
<br/>
同时,也可给定如下选项,以按位或的方式追加,默认不给定任何额外选项:
<br/>
-
0o100:若文件不存在,则创建文件。使用该选项时必须指定第三个参数
mode。
<br/>
-
0o200:如果追加了0o100选项,且文件已经存在,则出错。
<br/>
-
0o1000:如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。
<br/>
-
0o2000:以追加方式打开,后续写将追加到文件末尾。
<br/>
-
0o4000:如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续
IO
进行非阻塞操作。
<br/>
-
0o200000:如果path指向目录,则出错。
<br/>
-
0o400000:如果path指向符号链接,则出错。
<br/>
-
0o4010000:以同步IO的方式打开文件。 |
| mode | number | 否 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。
<br/>
-
0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。
<br/>
创建出的文件权限受umask影响,umask随进程启动确定,其修改当前不开放。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------ | ----------- |
| number | 打开文件的文件描述符。 |
-
**示例:**
**示例:**
```
js
let
fd
=
fileio
.
openSync
(
path
);
```
...
...
@@ -620,19 +620,19 @@ read(fd: number, buffer: ArrayBuffer, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待读取文件的文件描述符。 |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
-
约束
:
offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
-
约束
:
offset+length<=buffer.size。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ---------------------------------- | ------ |
| Promise
<
[ReadOut](#readout)
>
| 读取的结果。 |
-
**示例:**
**示例:**
```
js
let
fd
=
fileio
.
openSync
(
path
,
0o2
);
let
buf
=
new
ArrayBuffer
(
4096
);
...
...
@@ -657,15 +657,15 @@ read(fd: number, buffer: ArrayBuffer, options: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待读取文件的文件描述符。 |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
-
约束
:
offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
-
约束
:
offset+length<=buffer.size。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是 | 异步读取数据之后的回调。 |
-
**示例:**
**示例:**
```
js
let
fd
=
fileio
.
openSync
(
path
,
0o2
);
let
buf
=
new
ArrayBuffer
(
4096
);
...
...
@@ -690,19 +690,19 @@ readSync(fd: number, buffer: ArrayBuffer, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待读取文件的文件描述符。 |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
-
约束
:
offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
-
约束
:
offset+length<=buffer.size。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------ | -------- |
| number | 实际读取的长度。 |
-
**示例:**
**示例:**
```
js
let
fd
=
fileio
.
openSync
(
path
,
0o2
);
let
buf
=
new
ArrayBuffer
(
4096
);
...
...
@@ -718,17 +718,17 @@ rmdir(path: string): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------- |
| path | string | 是 | 待删除目录的绝对路径。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果。本调用将返回空值。 |
-
**示例:**
**示例:**
```
js
fileio
.
rmdir
(
path
).
then
(
function
()
{
console
.
info
(
"
rmdir successfully
"
);
...
...
@@ -746,13 +746,13 @@ rmdir(path: string, callback:AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------ |
| path | string | 是 | 待删除目录的绝对路径。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步删除目录之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
rmdir
(
path
,
function
(
err
){
// do something
...
...
@@ -769,12 +769,12 @@ rmdirSync(path: string): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------- |
| path | string | 是 | 待删除目录的绝对路径。 |
-
**示例:**
**示例:**
```
js
fileio
.
rmdirSync
(
path
);
```
...
...
@@ -788,17 +788,17 @@ unlink(path:string): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------- |
| path | string | 是 | 待删除文件的绝对路径。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果。本调用将返回空值。 |
-
**示例:**
**示例:**
```
js
fileio
.
unlink
(
path
).
then
(
function
(){
console
.
info
(
"
remove file successfully
"
);
...
...
@@ -816,13 +816,13 @@ unlink(path:string, callback:AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------ |
| path | string | 是 | 待删除文件的绝对路径。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步删除文件之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
unlink
(
path
,
function
(
err
)
{
console
.
info
(
"
remove file successfully
"
);
...
...
@@ -838,12 +838,12 @@ unlinkSync(path: string): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------- |
| path | string | 是 | 待删除文件的绝对路径。 |
-
**示例:**
**示例:**
```
js
fileio
.
unlinkSync
(
path
);
```
...
...
@@ -862,19 +862,19 @@ write(fd: number, buffer: ArrayBuffer | string, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待写入文件的文件描述符。 |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
-
约束
:
offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
-
约束
:
offset+length<=buffer.size。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| --------------------- | -------- |
| Promise
<
number
>
| 实际写入的长度。 |
-
**示例:**
**示例:**
```
js
let
fd
=
fileio
.
openSync
(
fpath
,
0o100
|
0o2
,
0o666
);
fileio
.
write
(
fd
,
"
hello, world
"
).
then
(
function
(
number
){
...
...
@@ -898,15 +898,15 @@ write(fd: number, buffer: ArrayBuffer | string, options: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待写入文件的文件描述符。 |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
-
约束
:
offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
-
约束
:
offset+length<=buffer.size。 |
| callback | AsyncCallback
<
number
>
| 是 | 异步将数据写入完成后执行的回调函数。 |
-
**示例:**
**示例:**
```
js
let
fd
=
fileio
.
openSync
(
path
,
0o100
|
0o2
,
0o666
);
fileio
.
write
(
fd
,
"
hello, world
"
,
function
(
err
,
bytesWritten
)
{
...
...
@@ -930,19 +930,19 @@ writeSync(fd: number, buffer: ArrayBuffer | string, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待写入文件的文件描述符。 |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
-
约束
:
offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
-
约束
:
offset+length<=buffer.size。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------ | -------- |
| number | 实际写入的长度。 |
-
**示例:**
**示例:**
```
js
let
fd
=
fileio
.
openSync
(
path
,
0o100
|
0o2
,
0o666
);
let
num
=
fileio
.
writeSync
(
fd
,
"
hello, world
"
);
...
...
@@ -957,18 +957,18 @@ hash(path: string, algorithm: string): Promise<string>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待计算哈希值文件的绝对路径。 |
| algorithm | string | 是 | 哈希计算采用的算法。可选
"md5"、"sha1"
或
"sha256"。建议采用安全强度更高的
"sha256"。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| --------------------- | -------------------------- |
| Promise
<
string
>
| 文件的哈希值。表示为十六进制数字串,所有字母均大写。 |
-
**示例:**
**示例:**
```
js
fileio
.
hash
(
path
,
"
sha256
"
).
then
(
function
(
str
){
console
.
info
(
"
calculate file hash successfully:
"
+
str
);
...
...
@@ -986,14 +986,14 @@ hash(path: string, algorithm: string, callback: AsyncCallback<string>): vo
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------------- | ---- | ---------------------------------------- |
| path | string | 是 | 待计算哈希值文件的绝对路径。 |
| algorithm | string | 是 | 哈希计算采用的算法。可选
"md5"、"sha1"
或
"sha256"。建议采用安全强度更高的
"sha256"。 |
| callback | AsyncCallback
<
string
>
| 是 | 异步计算文件哈希操之后的回调函数(其中给定文件哈希值表示为十六进制数字串,所有字母均大写)。 |
-
**示例:**
**示例:**
```
js
fileio
.
hash
(
fpath
,
"
sha256
"
,
function
(
err
,
hashStr
)
{
if
(
hashStr
)
{
...
...
@@ -1011,18 +1011,18 @@ chmod(path: string, mode: number):Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待改变文件权限的绝对路径。 |
| mode | number | 是 | 改变文件权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果。本调用将返回空值。 |
-
**示例:**
**示例:**
```
js
fileio
.
chmod
(
path
,
mode
).
then
(
function
()
{
console
.
info
(
"
chmod successfully
"
);
...
...
@@ -1040,14 +1040,14 @@ chmod(path: string, mode: number, callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------- |
| path | string | 是 | 待改变文件权限的绝对路径。 |
| mode | number | 是 | 改变文件权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步改变文件权限之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
chmod
(
path
,
mode
,
function
(
err
)
{
// do something
...
...
@@ -1063,13 +1063,13 @@ chmodSync(path: string, mode: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待改变文件权限的绝对路径。 |
| mode | number | 是 | 改变文件权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
-
**示例:**
**示例:**
```
js
fileio
.
chmodSync
(
fpath
,
mode
);
```
...
...
@@ -1083,17 +1083,17 @@ fstat(fd: number): Promise<Stat>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待获取文件的文件描述符。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ---------------------------- | ---------- |
| Promise
<
[Stat](#stat)
>
| 表示文件的具体信息。 |
-
**示例:**
**示例:**
```
js
fileio
.
fstat
(
fd
).
then
(
function
(
stat
){
console
.
info
(
"
fstat successfully:
"
+
JSON
.
stringify
(
stat
));
...
...
@@ -1111,13 +1111,13 @@ fstat(fd: number, callback: AsyncCallback<Stat>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------- | ---- | ---------------- |
| fd | number | 是 | 待获取文件的文件描述符。 |
| callback | AsyncCallback
<
[Stat](#stat)
>
| 是 | 异步获取文件状态信息之后的回调。 |
-
**示例:**
**示例:**
```
js
let
fd
=
fileio
.
openSync
(
path
);
fileio
.
fstat
(
fd
,
function
(
err
)
{
...
...
@@ -1134,17 +1134,17 @@ fstatSync(fd: number): Stat
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待获取文件的文件描述符。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------- | ---------- |
|
[
Stat
](
#stat
)
| 表示文件的具体信息。 |
-
**示例:**
**示例:**
```
js
let
fd
=
fileio
.
openSync
(
path
);
let
stat
=
fileio
.
fstatSync
(
fd
);
...
...
@@ -1159,18 +1159,18 @@ ftruncate(fd: number, len?: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------- |
| fd | number | 是 | 待截断文件的文件描述符。 |
| len | number | 是 | 文件截断后的长度,以字节为单位。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果。本调用将返回空值。 |
-
**示例:**
**示例:**
```
js
let
fd
=
fileio
.
openSync
(
path
);
fileio
.
ftruncate
(
fd
,
5
).
then
(
function
(
err
)
{
...
...
@@ -1189,14 +1189,14 @@ ftruncate(fd: number, len: number, callback:AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------- |
| fd | number | 是 | 待截断文件的文件描述符。 |
| len | number | 是 | 文件截断后的长度,以字节为单位。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步截断文件的信息之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
ftruncate
(
fd
,
len
,
function
(
err
){
// do something
...
...
@@ -1212,13 +1212,13 @@ ftruncateSync(fd: number, len?: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------- |
| fd | number | 是 | 待截断文件的文件描述符。 |
| len | number | 否 | 文件截断后的长度,以字节为单位。 |
-
**示例:**
**示例:**
```
js
fileio
.
ftruncateSync
(
fd
,
len
);
```
...
...
@@ -1232,18 +1232,18 @@ truncate(path: string, len?: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------- |
| path | string | 是 | 待截断文件的绝对路径。 |
| len | number | 是 | 文件截断后的长度,以字节为单位。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果。本调用将返回空值。 |
-
**示例:**
**示例:**
```
js
fileio
.
truncate
(
path
,
len
).
then
(
function
(){
console
.
info
(
"
truncate file successfully
"
);
...
...
@@ -1261,14 +1261,14 @@ truncate(path: string, len: number, callback:AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------- |
| path | string | 是 | 待截断文件的绝对路径。 |
| len | number | 是 | 文件截断后的长度,以字节为单位。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步截断文件的信息之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
truncate
(
path
,
len
,
function
(
err
){
// do something
...
...
@@ -1284,13 +1284,13 @@ truncateSync(path: string, len?: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------- |
| path | string | 是 | 待截断文件的绝对路径。 |
| len | number | 否 | 文件截断后的长度,以字节为单位。 |
-
**示例:**
**示例:**
```
js
fileio
.
truncateSync
(
path
,
len
);
```
...
...
@@ -1308,18 +1308,18 @@ readText(filePath: string, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------------------------------- |
| filePath | string | 是 | 待读取文件的绝对路径。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
encoding,string类型,当数据是
string
类型时有效,表示数据的编码方式,默认
'utf-8',仅支持
'utf-8'。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| --------------------- | ---------- |
| Promise
<
string
>
| 返回读取文件的内容。 |
-
**示例:**
**示例:**
```
js
fileio
.
readText
(
path
).
then
(
function
(
str
)
{
console
.
info
(
"
readText successfully:
"
+
str
);
...
...
@@ -1341,14 +1341,14 @@ readText(filePath: string, options: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ---------------------------------------- |
| filePath | string | 是 | 待读取文件的绝对路径。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
encoding,string类型,当数据是
string
类型时有效,表示数据的编码方式,默认
'utf-8',仅支持
'utf-8'。 |
| callback | AsyncCallback
<
string
>
| 是 | 异步通过文本方式读取文件之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
readText
(
path
,
function
(
err
,
str
){
// do something
...
...
@@ -1368,18 +1368,18 @@ readTextSync(filePath: string, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------------------------------- |
| filePath | string | 是 | 待读取文件的绝对路径。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
encoding,string类型,当数据是
string
类型时有效,表示数据的编码方式,默认
'utf-8',仅支持
'utf-8'。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------ | -------------------- |
| string | 返回读取文件的内容。 |
-
**示例:**
**示例:**
```
js
let
str
=
fileio
.
readTextSync
(
path
,
{
position
:
1
,
length
:
3
});
```
...
...
@@ -1393,17 +1393,17 @@ lstat(path: string): Promise<Stat>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------------- |
| path | string | 是 | 目标文件的绝对路径,指向链接状态。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ---------------------------- | ---------- |
| Promise
<
[Stat](#stat)
>
| 表示文件的具体信息。 |
-
**示例:**
**示例:**
```
js
fileio
.
lstat
(
path
).
then
(
function
(
stat
){
console
.
info
(
"
get link status successfully:
"
+
number
);
...
...
@@ -1421,13 +1421,13 @@ lstat(path:string, callback:AsyncCallback<Stat>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------- | ---- | ----------------- |
| path | string | 是 | 目标文件的绝对路径,指向链接状态。 |
| callback | AsyncCallback
<
[Stat](#stat)
>
| 是 | 异步获取链接状态信息之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
lstat
(
path
,
function
(
err
,
stat
)
{
// do something
...
...
@@ -1443,17 +1443,17 @@ lstatSync(path:string): Stat
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------------- |
| path | string | 是 | 目标文件的绝对路径,指向链接状态。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------- | ---------- |
|
[
Stat
](
#stat
)
| 表示文件的具体信息。 |
-
**示例:**
**示例:**
```
js
let
stat
=
fileio
.
lstatSync
(
path
);
```
...
...
@@ -1471,18 +1471,18 @@ read(buffer: ArrayBuffer, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------- | ---- | ------------------------------------------------------------ |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
约束
:
offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
约束
:
offset+length<=buffer.size。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ---------------------------------- | ------ |
| Promise
<
[ReadOut](#readout)
>
| 读取的结果。 |
-
**示例:**
**示例:**
```
js
fileio
.
read
(
new
ArrayBuffer
(
4096
)).
then
(
function
(
readout
){
console
.
info
(
"
read file data successfully
"
);
...
...
@@ -1505,14 +1505,14 @@ read(buffer: ArrayBuffer, options: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
约束
:
offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
约束
:
offset+length<=buffer.size。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是 | 异步从文件读取数据之后的回调。 |
-
**示例:**
**示例:**
```
js
let
buf
=
new
ArrayBuffer
(
4096
);
fileio
.
read
(
buf
,
function
(
err
,
readOut
)
{
...
...
@@ -1532,18 +1532,18 @@ rename(oldPath: string, newPath: string): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------------------ |
| oldPath | string | 是 | 目标文件的当前绝对路径。 |
| newPath | String | 是 | 目标文件的新绝对路径。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果。本调用将返回空值。 |
-
**示例:**
**示例:**
```
js
fileio
.
rename
(
oldPath
,
newPath
).
then
(
function
()
{
console
.
info
(
"
rename successfully
"
);
...
...
@@ -1561,14 +1561,14 @@ rename(oldPath: string, newPath: string, callback: AsyncCallback<void>): v
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------- |
| oldPath | string | 是 | 目标文件的当前绝对路径。 |
| newPath | String | 是 | 目标文件的新绝对路径。 |
| Callback | AsyncCallback
<
void
>
| 是 | 异步重命名文件之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
rename
(
oldPath
,
newPath
,
function
(
err
){
});
...
...
@@ -1583,13 +1583,13 @@ renameSync(oldPath: string, newPath: string): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------ |
| oldPath | string | 是 | 目标文件的当前绝对路径。 |
| newPath | String | 是 | 目标文件的新绝对路径。 |
-
**示例:**
**示例:**
```
js
fileio
.
renameSync
(
oldPath
,
newPath
);
```
...
...
@@ -1603,17 +1603,17 @@ fsync(fd: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果。本调用将返回空值。 |
-
**示例:**
**示例:**
```
js
fileio
.
fsync
(
fd
).
then
(
function
(){
console
.
info
(
"
sync data successfully
"
);
...
...
@@ -1631,13 +1631,13 @@ fsync(fd: number, callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | --------------- |
| fd | number | 是 | 待同步文件的文件描述符。 |
| Callback | AsyncCallback
<
void
>
| 是 | 异步将文件数据同步之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
fsync
(
fd
,
function
(
err
){
// do something
...
...
@@ -1653,12 +1653,12 @@ fsyncSync(fd: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 |
-
**示例:**
**示例:**
```
js
fileio
.
fyncsSync
(
fd
);
```
...
...
@@ -1672,17 +1672,17 @@ fdatasync(fd: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果,本调用将返回空值。 |
-
**示例:**
**示例:**
```
js
fileio
.
fdatasync
(
fd
).
then
(
function
(
err
)
{
console
.
info
(
"
sync data successfully
"
);
...
...
@@ -1700,13 +1700,13 @@ fdatasync(fd: number, callback:AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ----------------- |
| fd | number | 是 | 待同步文件的文件描述符。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步将文件内容数据同步之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
fdatasync
(
fd
,
function
(
err
)
{
// do something
...
...
@@ -1722,12 +1722,12 @@ fdatasyncSync(fd: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 |
-
**示例:**
**示例:**
```
js
let
stat
=
fileio
.
fdatasyncSync
(
fd
);
```
...
...
@@ -1741,18 +1741,18 @@ symlink(target: string, srcPath: string): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------ |
| target | string | 是 | 目标文件的绝对路径。 |
| srcPath | string | 是 | 符号链接文件的绝对路径。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果,本调用将返回空值。 |
-
**示例:**
**示例:**
```
js
fileio
.
symlink
(
target
,
srcPath
).
then
(
function
()
{
console
.
info
(
"
symlink successfully
"
);
...
...
@@ -1770,14 +1770,14 @@ symlink(target: string, srcPath: string, callback: AsyncCallback<void>): v
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------- |
| target | string | 是 | 目标文件的绝对路径。 |
| srcPath | string | 是 | 符号链接文件的绝对路径。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步创建符号链接信息之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
symlink
(
target
,
srcPath
,
function
(
err
)
{
// do something
...
...
@@ -1793,13 +1793,13 @@ symlinkSync(target: string, srcPath: string): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------ |
| target | string | 是 | 目标文件的绝对路径。 |
| srcPath | string | 是 | 符号链接文件的绝对路径。 |
-
**示例:**
**示例:**
```
js
fileio
.
symlinkSync
(
target
,
srcPath
);
```
...
...
@@ -1813,19 +1813,19 @@ chown(path: string, uid: number, gid: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | --------------- |
| path | string | 是 | 待改变文件的绝对路径。 |
| uid | number | 是 | 新的UID(UserID)。 |
| gid | number | 是 | 新的GID(GroupID)。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果,本调用将返回空值。 |
-
**示例:**
**示例:**
```
js
let
stat
=
fileio
.
statSync
(
path
);
fileio
.
chown
(
path
,
stat
.
uid
,
stat
.
gid
).
then
(
function
(){
...
...
@@ -1844,7 +1844,7 @@ chown(path: string, uid: number, gid: number, callback: AsyncCallback<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | --------------- |
| path | string | 是 | 待改变文件的绝对路径。 |
...
...
@@ -1852,7 +1852,7 @@ chown(path: string, uid: number, gid: number, callback: AsyncCallback<void>
| gid | number | 是 | 新的GID。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步改变文件所有者之后的回调。 |
-
**示例:**
**示例:**
```
js
let
stat
=
fileio
.
statSync
(
fpath
)
fileio
.
chown
(
path
,
stat
.
uid
,
stat
.
gid
,
function
(
err
){
...
...
@@ -1869,14 +1869,14 @@ chownSync(path: string, uid: number, gid: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------- |
| path | string | 是 | 待改变文件的绝对路径。 |
| uid | number | 是 | 新的UID。 |
| gid | number | 是 | 新的GID。 |
-
**示例:**
**示例:**
```
js
let
stat
=
fileio
.
statSync
(
fpath
)
fileio
.
chownSync
(
path
,
stat
.
uid
,
stat
.
gid
);
...
...
@@ -1891,17 +1891,17 @@ mkdtemp(prefix: string): Promise<string>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | --------------------------- |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
-
**返回值:**
**返回值:**
| 参数名 | 说明 |
| --------------------- | ---------- |
| Promise
<
string
>
| 生成的唯一目录路径。 |
-
**示例:**
**示例:**
```
js
fileio
.
mkdtemp
(
path
+
"
XXXX
"
).
then
(
function
(
path
){
console
.
info
(
"
mkdtemp successfully:
"
+
path
);
...
...
@@ -1919,13 +1919,13 @@ mkdtemp(prefix: string, callback: AsyncCallback<string>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------------------- |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
| callback | AsyncCallback
<
string
>
| 是 | 异步创建临时目录之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
mkdtemp
(
path
+
"
XXXX
"
,
function
(
err
,
res
)
{
// do something
...
...
@@ -1941,17 +1941,17 @@ mkdtempSync(prefix: string): string
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | --------------------------- |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
-
**返回值:**
**返回值:**
| 参数名 | 说明 |
| ------ | ---------- |
| string | 产生的唯一目录路径。 |
-
**示例:**
**示例:**
```
js
let
res
=
fileio
.
mkdtempSync
(
path
+
"
XXXX
"
);
```
...
...
@@ -1965,18 +1965,18 @@ fchmod(fd: number, mode: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待改变文件的文件描述符。 |
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
-
**返回值:**
**返回值:**
| 参数名 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果,本调用将返回空值。 |
-
**示例:**
**示例:**
```
js
fileio
.
fchmod
(
fd
,
mode
).
then
(
function
()
{
console
.
info
(
"
chmod successfully
"
);
...
...
@@ -1994,14 +1994,14 @@ fchmod(fd: number, mode: number, callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待改变文件的文件描述符。 |
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步改变文件权限之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
fchmod
(
fd
,
mode
,
function
(
err
)
{
// do something
...
...
@@ -2017,13 +2017,13 @@ fchmodSync(fd: number, mode: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待改变文件的文件描述符。 |
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
-
**示例:**
**示例:**
```
js
fileio
.
fchmodSync
(
fd
,
mode
);
```
...
...
@@ -2037,18 +2037,18 @@ createStream(path: string, mode: string): Promise<Stream>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待打开文件的绝对路径。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| --------------------------------- | --------- |
| Promise
<
[Stream](#stream7)
>
| 返回文件流的结果。 |
-
**示例:**
**示例:**
```
js
fileio
.
createStream
(
path
,
"
r+
"
).
then
(
function
(
stream
){
console
.
info
(
"
createStream successfully
"
);
...
...
@@ -2066,14 +2066,14 @@ createStream(path: string, mode: string, callback: AsyncCallback<Stream>):
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------------------------------------- |
| path | string | 是 | 待打开文件的绝对路径。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
| callback | AsyncCallback
<
[Stream](#stream7)
>
| 是 | 异步打开文件流之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
createStream
(
path
,
mode
,
function
(
err
,
stream
){
// do something
...
...
@@ -2089,18 +2089,18 @@ createStreamSync(path: string, mode: string): Stream
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待打开文件的绝对路径。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
-
**返回值:**
**返回值:**
| 参数名 | 说明 |
| ------------------ | --------- |
|
[
Stream
](
#stream7
)
| 返回文件流的结果。 |
-
**示例:**
**示例:**
```
js
let
ss
=
fileio
.
createStreamSync
(
path
,
"
r+
"
);
```
...
...
@@ -2114,18 +2114,18 @@ fdopenStream(fd: number, mode: string): Promise<Stream>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待打开文件的文件描述符。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
-
**返回值:**
**返回值:**
| 参数名 | 说明 |
| --------------------------------- | --------- |
| Promise
<
[Stream](#stream7)
>
| 返回文件流的结果。 |
-
**示例:**
**示例:**
```
js
fileio
.
fdopenStream
(
fd
,
mode
).
then
(
function
(
stream
){
console
.
info
(
"
openStream successfully
"
);
...
...
@@ -2143,14 +2143,14 @@ fdopenStream(fd: number, mode: string, callback: AsyncCallback<Stream>): v
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待打开文件的文件描述符。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
| callback | AsyncCallback
<
[Stream](#stream7)
>
| 是 | 异步打开文件流之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
fdopenStream
(
fd
,
mode
,
function
(
err
,
stream
)
{
// do something
...
...
@@ -2166,18 +2166,18 @@ fdopenStreamSync(fd: number, mode: string): Stream
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待打开文件的文件描述符。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
-
**返回值:**
**返回值:**
| 参数名 | 说明 |
| ------------------ | --------- |
|
[
Stream
](
#stream7
)
| 返回文件流的结果。 |
-
**示例:**
**示例:**
```
js
let
ss
=
fileio
.
fdopenStreamSync
(
fd
,
"
r+
"
);
```
...
...
@@ -2191,19 +2191,19 @@ fchown(fd: number, uid: number, gid: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待改变文件的文件描述符。 |
| uid | number | 是 | 文件所有者的UID。 |
| gid | number | 是 | 文件所有组的GID。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果。本调用将返回空值。 |
-
**示例:**
**示例:**
```
js
let
stat
=
fileio
.
statSync
(
path
);
fileio
.
fchown
(
fd
,
stat
.
uid
,
stat
.
gid
).
then
(
function
()
{
...
...
@@ -2222,7 +2222,7 @@ fchown(fd: number, uid: number, gid: number, callback: AsyncCallback<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | --------------- |
| fd | number | 是 | 待改变文件的文件描述符。 |
...
...
@@ -2230,7 +2230,7 @@ fchown(fd: number, uid: number, gid: number, callback: AsyncCallback<void>
| gid | number | 是 | 文件所有组的GID。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步改变文件所有者之后的回调。 |
-
**示例:**
**示例:**
```
js
let
stat
=
fileio
.
statSync
(
fpath
);
fileio
.
fchown
(
fd
,
stat
.
uid
,
stat
.
gid
,
function
(
err
){
...
...
@@ -2247,14 +2247,14 @@ fchownSync(fd: number, uid: number, gid: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待改变文件的文件描述符。 |
| uid | number | 是 | 文件所有者的UID。 |
| gid | number | 是 | 文件所有组的GID。 |
-
**示例:**
**示例:**
```
js
let
stat
=
fileio
.
statSync
(
fpath
);
fileio
.
fchownSync
(
fd
,
stat
.
uid
,
stat
.
gid
);
...
...
@@ -2269,19 +2269,19 @@ lchown(path: string, uid: number, gid: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------- |
| path | string | 是 | 待打开文件的绝对路径。 |
| uid | number | 是 | 新的UID。 |
| gid | number | 是 | 新的GID。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果。本调用将返回空值。 |
-
**示例:**
**示例:**
```
js
let
stat
=
fileio
.
statSync
(
path
);
fileio
.
lchown
(
path
,
stat
.
uid
,
stat
.
gid
).
then
(
function
()
{
...
...
@@ -2300,7 +2300,7 @@ lchown(path: string, uid: number, gid: number, callback: AsyncCallback<void&g
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | --------------- |
| path | string | 是 | 待打开文件的绝对路径。 |
...
...
@@ -2308,7 +2308,7 @@ lchown(path: string, uid: number, gid: number, callback: AsyncCallback<void&g
| gid | number | 是 | 新的GID。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步改变文件所有者之后的回调。 |
-
**示例:**
**示例:**
```
js
let
stat
=
fileio
.
statSync
(
path
);
fileio
.
lchown
(
path
,
stat
.
uid
,
stat
.
gid
,
function
(
err
){
...
...
@@ -2325,14 +2325,14 @@ lchownSync(path: string, uid: number, gid: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------- |
| path | string | 是 | 待打开文件的绝对路径。 |
| uid | number | 是 | 新的UID。 |
| gid | number | 是 | 新的GID。 |
-
**示例:**
**示例:**
```
js
let
stat
=
fileio
.
statSync
(
path
);
fileio
.
lchownSync
(
path
,
stat
.
uid
,
stat
.
gid
);
...
...
@@ -2347,19 +2347,19 @@ createWatcher(filename: string, events: number, callback: AsyncCallback<numbe
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------- | ---- | ---------------------------------------- |
| filename | string | 是 | 待监视文件的绝对路径。 |
| events | Number | 是 | -
1:
监听文件或者目录是否发生重命名。
<br/>
-
2:监听文件或者目录内容的是否修改。
<br/>
-
3:两者都有。 |
| callback | AsyncCallback
<
number
>
| 是 | 每发生变化一次,调用一次此函数。 |
-
**返回值:**
**返回值:**
| 参数名 | 说明 |
| -------------------- | ---------- |
|
[
Watcher
](
#watcher7
)
| 文件变化监听的实例。 |
-
**示例:**
**示例:**
```
js
fileio
.
createWatcher
(
filename
,
events
,
function
(
watcher
){
// do something
...
...
@@ -2412,12 +2412,12 @@ isBlockDevice(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------- | ---------------- |
| boolean | 表示文件是否是块特殊设备。 |
-
**示例:**
**示例:**
```
js
let
isBLockDevice
=
fileio
.
statSync
(
path
).
isBlockDevice
();
```
...
...
@@ -2431,12 +2431,12 @@ isCharacterDevice(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------- | ----------------- |
| boolean | 表示文件是否是字符特殊设备。 |
-
**示例:**
**示例:**
```
js
let
isCharacterDevice
=
fileio
.
statSync
(
path
).
isCharacterDevice
();
```
...
...
@@ -2450,12 +2450,12 @@ isDirectory(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------- | ------------- |
| boolean | 表示文件是否是目录。 |
-
**示例:**
**示例:**
```
js
let
isDirectory
=
fileio
.
statSync
(
path
).
isDirectory
();
```
...
...
@@ -2469,12 +2469,12 @@ isFIFO(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------- | --------------------- |
| boolean | 表示文件是否是
FIFO。 |
-
**示例:**
**示例:**
```
js
let
isFIFO
=
fileio
.
statSync
(
path
).
isFIFO
();
```
...
...
@@ -2488,12 +2488,12 @@ isFile(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------- | --------------- |
| boolean | 表示文件是否是普通文件。 |
-
**示例:**
**示例:**
```
js
let
isFile
=
fileio
.
statSync
(
fpath
).
isFile
();
```
...
...
@@ -2507,12 +2507,12 @@ isSocket(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------- | -------------- |
| boolean | 表示文件是否是套接字。 |
-
**示例:**
**示例:**
```
js
let
isSocket
=
fileio
.
statSync
(
path
).
isSocket
();
```
...
...
@@ -2526,12 +2526,12 @@ isSymbolicLink(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------- | --------------- |
| boolean | 表示文件是否是符号链接。 |
-
**示例:**
**示例:**
```
js
let
isSymbolicLink
=
fileio
.
statSync
(
path
).
isSymbolicLink
();
```
...
...
@@ -2550,7 +2550,7 @@ stop(): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**示例:**
**示例:**
```
js
fileio
.
stop
();
```
...
...
@@ -2564,12 +2564,12 @@ stop(callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------- |
| callback | AsyncCallback
<
void
>
| 是 | 以异步方法关闭watcher监听之后的回调。 |
-
**示例:**
**示例:**
```
js
fileio
.
stop
(
function
(
err
){
// do something
...
...
@@ -2590,12 +2590,12 @@ close(): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------- |
| Promise
<
void
>
| 表示异步关闭文件流的结果。 |
-
**示例:**
**示例:**
```
js
let
ss
=
fileio
.
createStreamSync
(
path
);
ss
.
close
().
then
(
function
(){
...
...
@@ -2614,12 +2614,12 @@ close(callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------- |
| callback | AsyncCallback
<
void
>
| 是 | 异步关闭文件流之后的回调。 |
-
**示例:**
**示例:**
```
js
let
ss
=
fileio
.
createStreamSync
(
path
);
ss
.
close
(
function
(
err
)
{
...
...
@@ -2636,7 +2636,7 @@ closeSync(): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**示例:**
**示例:**
```
js
let
ss
=
fileio
.
createStreamSync
(
path
);
ss
.
closeSync
();
...
...
@@ -2651,12 +2651,12 @@ flush(): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------- |
| Promise
<
void
>
| 表示异步刷新文件流的结果。 |
-
**示例:**
**示例:**
```
js
let
ss
=
fileio
.
createStreamSync
(
path
);
ss
.
flush
().
then
(
function
(){
...
...
@@ -2675,12 +2675,12 @@ flush(callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------------- |
| callback | AsyncCallback
<
void
>
| 是 | 异步刷新文件流后的回调函数。 |
-
**示例:**
**示例:**
```
js
let
ss
=
fileio
.
createStreamSync
(
path
);
ss
.
flush
(
function
(
err
)
{
...
...
@@ -2697,7 +2697,7 @@ flushSync(): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**示例:**
**示例:**
```
js
let
ss
=
fileio
.
createStreamSync
(
path
);
ss
.
flushSync
();
...
...
@@ -2717,18 +2717,18 @@ write(buffer: ArrayBuffer | string, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
-
约束
:
offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
-
约束
:
offset+length<=buffer.size。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| --------------------- | -------- |
| Promise
<
number
>
| 实际写入的长度。 |
-
**示例:**
**示例:**
```
js
let
ss
=
fileio
.
createStreamSync
(
fpath
,
"
r+
"
);
ss
.
write
(
"
hello, world
"
,{
offset
:
1
,
length
:
5
,
position
:
5
,
encoding
:
'
utf-8
'
}).
then
(
function
(
number
){
...
...
@@ -2752,14 +2752,14 @@ write(buffer: ArrayBuffer | string, options: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
-
约束
:
offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
-
约束
:
offset+length<=buffer.size。 |
| callback | AsyncCallback
<
number
>
| 是 | 异步写入完成后执行的回调函数。 |
-
**示例:**
**示例:**
```
js
let
ss
=
fileio
.
createStreamSync
(
fpath
,
"
r+
"
);
ss
.
write
(
"
hello, world
"
,
{
offset
:
1
,
length
:
5
,
position
:
5
,
encoding
:
'
utf-8
'
},
function
(
err
,
bytesWritten
)
{
...
...
@@ -2784,18 +2784,18 @@ writeSync(buffer: ArrayBuffer | string, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
-
约束
:
offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
-
约束
:
offset+length<=buffer.size。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------ | -------- |
| number | 实际写入的长度。 |
-
**示例:**
**示例:**
```
js
let
ss
=
fileio
.
createStreamSync
(
fpath
,
"
r+
"
);
let
num
=
ss
.
writeSync
(
"
hello, world
"
,
{
offset
:
1
,
length
:
5
,
position
:
5
,
encoding
:
'
utf-8
'
});
...
...
@@ -2814,18 +2814,18 @@ read(buffer: ArrayBuffer, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
-
约束
:
offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
-
约束
:
offset+length<=buffer.size。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ---------------------------------- | ------ |
| Promise
<
[ReadOut](#readout)
>
| 读取的结果。 |
-
**示例:**
**示例:**
```
js
let
ss
=
fileio
.
createStreamSync
(
fpath
,
"
r+
"
);
ss
.
read
(
new
ArrayBuffer
(
4096
),
{
offset
:
1
,
length
:
5
,
position
:
5
}).
then
(
function
(
readout
){
...
...
@@ -2849,14 +2849,14 @@ read(buffer: ArrayBuffer, options: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
-
约束
:
offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
-
约束
:
offset+length<=buffer.size。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是 | 异步从流文件读取数据之后的回调。 |
-
**示例:**
**示例:**
```
js
let
ss
=
fileio
.
createStreamSync
(
fpath
,
"
r+
"
);
ss
.
read
(
new
ArrayBuffer
(
4096
),{
offset
:
1
,
length
:
5
,
position
:
5
},
function
(
err
,
readOut
)
{
...
...
@@ -2880,20 +2880,20 @@ readSync(buffer: ArrayBuffer, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
-
约束
:
offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
-
约束
:
offset+length<=buffer.size。 |
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------ | -------- |
| number | 实际读取的长度。 |
-
**示例:**
**示例:**
```
js
let
ss
=
fileio
.
createStreamSync
(
fpath
,
"
r+
"
);
let
num
=
ss
.
readSync
(
new
ArrayBuffer
(
4096
),
{
offset
:
1
,
length
:
5
,
position
:
5
});
...
...
@@ -2913,12 +2913,12 @@ read(): Promise<Dirent>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| -------------------------------- | ------------- |
| Promise
<
[Dirent](#dirent)
>
| 表示异步读取目录项的结果。 |
-
**示例:**
**示例:**
```
js
let
dir
=
fileio
.
opendirSync
(
path
);
dir
.
read
().
then
(
function
(
dirent
){
...
...
@@ -2937,12 +2937,12 @@ read(callback: AsyncCallback<Dirent>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ---------------- |
| callback | AsyncCallback
<
[Dirent](#dirent)
>
| 是 | 异步读取下一个目录项之后的回调。 |
-
**示例:**
**示例:**
```
js
let
dir
=
fileio
.
opendirSync
(
path
);
dir
.
read
(
function
(
err
,
dirent
)
{
...
...
@@ -2962,12 +2962,12 @@ readSync(): Dirent
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ----------------- | -------- |
|
[
Dirent
](
#dirent
)
| 表示一个目录项。 |
-
**示例:**
**示例:**
```
js
let
dir
=
fileio
.
opendirSync
(
path
);
let
dirent
=
dir
.
readSync
();
...
...
@@ -2982,7 +2982,7 @@ closeSync(): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**示例:**
**示例:**
```
js
let
dir
=
fileio
.
opendirSync
(
path
);
dir
.
closeSync
();
...
...
@@ -3010,12 +3010,12 @@ isBlockDevice(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------- | ---------------- |
| boolean | 表示当前目录项是否是块特殊设备。 |
-
**示例:**
**示例:**
```
js
let
dir
=
fileio
.
opendirSync
(
path
);
let
isBLockDevice
=
dir
.
readSync
().
isBlockDevice
();
...
...
@@ -3030,12 +3030,12 @@ isCharacterDevice(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------- | ----------------- |
| boolean | 表示当前目录项是否是字符特殊设备。 |
-
**示例:**
**示例:**
```
js
let
dir
=
fileio
.
opendirSync
(
path
);
let
isCharacterDevice
=
dir
.
readSync
().
isCharacterDevice
();
...
...
@@ -3050,12 +3050,12 @@ isDirectory(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------- | ------------- |
| boolean | 表示当前目录项是否是目录。 |
-
**示例:**
**示例:**
```
js
let
dir
=
fileio
.
opendirSync
(
path
);
let
isDirectory
=
dir
.
readSync
().
isDirectory
();
...
...
@@ -3070,12 +3070,12 @@ isFIFO(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------- | --------------- |
| boolean | 表示当前目录项是否是FIFO。 |
-
**示例:**
**示例:**
```
js
let
dir
=
fileio
.
opendirSync
(
path
);
let
isFIFO
=
dir
.
readSync
().
isFIFO
();
...
...
@@ -3090,12 +3090,12 @@ isFile(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------- | --------------- |
| boolean | 表示当前目录项是否是普通文件。 |
-
**示例:**
**示例:**
```
js
let
dir
=
fileio
.
opendirSync
(
path
);
let
isFile
=
dir
.
readSync
().
isFile
();
...
...
@@ -3110,12 +3110,12 @@ isSocket(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------- | -------------- |
| boolean | 表示当前目录项是否是套接字。 |
-
**示例:**
**示例:**
```
js
let
dir
=
fileio
.
opendirSync
(
dpath
);
let
isSocket
=
dir
.
readSync
().
isSocket
();
...
...
@@ -3130,12 +3130,12 @@ isSymbolicLink(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------- | --------------- |
| boolean | 表示当前目录项是否是符号链接。 |
-
**示例:**
**示例:**
```
js
let
dir
=
fileio
.
opendirSync
(
path
);
let
isSymbolicLink
=
dir
.
readSync
().
isSymbolicLink
();
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录