Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
5fb481ef
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
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看板
提交
5fb481ef
编写于
11月 18, 2022
作者:
Z
zhuhongtao666
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
bugfix_fileio_dts
Signed-off-by:
N
zhuhongtao666
<
zhuhongtao12@huawei.com
>
上级
03e66a98
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
25 addition
and
25 deletion
+25
-25
zh-cn/application-dev/reference/apis/js-apis-fileio.md
zh-cn/application-dev/reference/apis/js-apis-fileio.md
+25
-25
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-fileio.md
浏览文件 @
5fb481ef
...
...
@@ -250,7 +250,7 @@ access(path: string, mode?: number): Promise<void>
## fileio.access
access(path: string, mode: number, callback: AsyncCallback
<
void
>
): void
access(path: string, mode
?
: number, callback: AsyncCallback
<
void
>
): void
检查当前进程是否可访问某文件,使用callback异步回调。
...
...
@@ -395,8 +395,8 @@ copyFile(src: string | number, dest: string | number, mode?: number): Promise<
| 参数名 | 类型 | 必填 | 说明 |
| ---- | -------------------------- | ---- | ---------------------------------------- |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
<br/>
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
**返回值:**
...
...
@@ -430,8 +430,8 @@ copyFile(src: string | number, dest: string | number, mode: number, callback: As
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ---------------------------------------- |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
<br/>
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步复制文件之后的回调。 |
...
...
@@ -458,8 +458,8 @@ copyFileSync(src: string | number, dest: string | number, mode?: number): void
| 参数名 | 类型 | 必填 | 说明 |
| ---- | -------------------------- | ---- | ---------------------------------------- |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
<br/>
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
**示例:**
...
...
@@ -602,7 +602,7 @@ open(path: string, flags: number, mode: number, callback: AsyncCallback<numbe
| 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:其余用户具有可执行权限。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步打开文件之后的回调。 |
| callback | AsyncCallback
<
number
>
| 是 | 异步打开文件之后的回调。 |
**示例:**
...
...
@@ -991,7 +991,7 @@ writeSync(fd: number, buffer: ArrayBuffer | string, options?: { offset?: number;
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待写入文件的文件描述符。 |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| 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。 |
**返回值:**
...
...
@@ -1598,7 +1598,7 @@ rename(oldPath: string, newPath: string): Promise<void>
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ---------------------------- |
| oldPath | string | 是 | 目标文件的当前应用沙箱路径。 |
| newPath |
S
tring | 是 | 目标文件的新应用沙箱路径。 |
| newPath |
s
tring | 是 | 目标文件的新应用沙箱路径。 |
**返回值:**
...
...
@@ -1632,8 +1632,8 @@ rename(oldPath: string, newPath: string, callback: AsyncCallback<void>): v
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------- |
| oldPath | string | 是 | 目标文件的当前应用沙箱路径。 |
| newPath |
S
tring | 是 | 目标文件的新应用沙箱路径。 |
|
C
allback | AsyncCallback
<
void
>
| 是 | 异步重命名文件之后的回调。 |
| newPath |
s
tring | 是 | 目标文件的新应用沙箱路径。 |
|
c
allback | AsyncCallback
<
void
>
| 是 | 异步重命名文件之后的回调。 |
**示例:**
...
...
@@ -1658,7 +1658,7 @@ renameSync(oldPath: string, newPath: string): void
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ---------------------------- |
| oldPath | string | 是 | 目标文件的当前应用沙箱路径。 |
| newPath |
S
tring | 是 | 目标文件的新应用沙箱路径。 |
| newPath |
s
tring | 是 | 目标文件的新应用沙箱路径。 |
**示例:**
...
...
@@ -1797,7 +1797,7 @@ fdatasync(fd: number, callback: AsyncCallback<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ----------------- |
| fd | number | 是 | 待同步文件的文件描述符。 |
| callback | AsyncCallback
&
nbsp;&
lt;
void
>
| 是 | 异步将文件内容数据同步之后的回调。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步将文件内容数据同步之后的回调。 |
**示例:**
...
...
@@ -2137,7 +2137,7 @@ fchmod(fd: number, mode: number, callback: AsyncCallback<void>): void
| -------- | ------------------------------- | ---- | ---------------------------------------- |
| 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
&
nbsp;&
lt;
void
>
| 是 | 异步改变文件权限之后的回调。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步改变文件权限之后的回调。 |
**示例:**
...
...
@@ -2312,7 +2312,7 @@ fdopenStream(fd: number, mode: string, callback: AsyncCallback<Stream>): v
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待打开文件的文件描述符。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
| callback | AsyncCallback
&
nbsp;&
lt;
[Stream](#stream)
>
| 是 | 异步打开文件流之后的回调。 |
| callback | AsyncCallback
<
[Stream](#stream)
>
| 是 | 异步打开文件流之后的回调。 |
**示例:**
...
...
@@ -2547,8 +2547,8 @@ createWatcher(filename: string, events: number, callback: AsyncCallback<numbe
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------- | ---- | ------------------------------------------------------------ |
| filePath | string | 是 | 待监视文件的应用沙箱路径。 |
| events |
N
umber | 是 | -
1:
监听文件或者目录是否发生重命名。
<br/>
-
2:监听文件或者目录内容的是否修改。
<br/>
-
3:两者都有。 |
| callback | AsyncCallback
<
number
&
nbsp;&
gt;
| 是 | 每发生变化一次,调用一次此函数。 |
| events |
n
umber | 是 | -
1:
监听文件或者目录是否发生重命名。
<br/>
-
2:监听文件或者目录内容的是否修改。
<br/>
-
3:两者都有。 |
| callback | AsyncCallback
<
number
>
| 是 | 每发生变化一次,调用一次此函数。 |
**返回值:**
...
...
@@ -2573,7 +2573,7 @@ createWatcher(filename: string, events: number, callback: AsyncCallback<numbe
**系统能力**
:以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。
| 名称 |
参数
类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | ---------- | ---- | ---- | ----------------- |
| bytesRead | number | 是 | 是 | 实际读取长度。 |
| offset | number | 是 | 是 | 读取数据相对于缓冲区首地址的偏移。 |
...
...
@@ -2588,7 +2588,7 @@ createWatcher(filename: string, events: number, callback: AsyncCallback<numbe
### 属性
| 名称 |
参数
类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ---- | ---- | ---------------------------------------- |
| dev | number | 是 | 否 | 标识包含该文件的主设备号。 |
| ino | number | 是 | 否 | 标识该文件。通常同设备上的不同文件的INO不同。 |
...
...
@@ -2966,7 +2966,7 @@ write(buffer: ArrayBuffer | string, options?: { offset?: number; length?: number
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| 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。 |
**返回值:**
...
...
@@ -3000,7 +3000,7 @@ write(buffer: ArrayBuffer | string, options: { offset?: number; length?: number;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| 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。 |
| callback | AsyncCallback
<
number
>
| 是 | 异步写入完成后执行的回调函数。 |
...
...
@@ -3030,7 +3030,7 @@ writeSync(buffer: ArrayBuffer | string, options?: { offset?: number; length?: nu
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| 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。 |
**返回值:**
...
...
@@ -3277,7 +3277,7 @@ closeSync(): void
### 属性
| 名称 |
参数
类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ---- | ------ | ---- | ---- | ------- |
| name | string | 是 | 否 | 目录项的名称。 |
...
...
@@ -3443,7 +3443,7 @@ isSymbolicLink(): boolean
文件过滤器配置项。
| 名称 |
参数
类型 | 说明 |
| 名称 | 类型 | 说明 |
| ----------- | --------------- | ------------------ |
| suffix | Array
<
string
>
| 文件后缀名,各个关键词OR关系。 |
| displayName | Array
<
string
>
| 文件名模糊匹配,各个关键词OR关系。 |
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录