diff --git a/zh-cn/application-dev/reference/apis/js-apis-document.md b/zh-cn/application-dev/reference/apis/js-apis-document.md index 4218d25e7491b2fb60659416f0dd91648b8aa6bc..01d6e24a1c50a71f3e42bdf383315a6fc48e43d6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-document.md +++ b/zh-cn/application-dev/reference/apis/js-apis-document.md @@ -1,8 +1,8 @@ # 文件交互 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -- 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -- 本模块接口后续将废弃。不建议在OpenHarmony使用以下接口，调用以下接口将抛出异常。 +> - 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> - 本模块接口后续将废弃。不建议在OpenHarmony使用以下接口，调用以下接口将抛出异常。 ## 导入模块 diff --git a/zh-cn/application-dev/reference/apis/js-apis-fileio.md b/zh-cn/application-dev/reference/apis/js-apis-fileio.md index f04103f1e8b72a2e166db480680504996b57963a..fc4205ce6cf0407ba851aceff378213e2abf89f6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-fileio.md +++ b/zh-cn/application-dev/reference/apis/js-apis-fileio.md @@ -14,11 +14,11 @@ import fileio from '@ohos.fileio'; ## 使用说明 -使用该功能模块对文件/目录进行操作前，需要先获取其绝对路径，获取方式及其接口用法请参考：[Context模块的接口getOrCreateLocalDir](js-apis-Context.md)。 +使用该功能模块对文件/目录进行操作前，需要先获取其应用沙箱路径，获取方式及其接口用法请参考：[Context模块的接口getOrCreateLocalDir](js-apis-Context.md)。 -“文件/目录绝对路径”=“应用目录路径”+“文件/目录名” +“文件/目录应用沙箱路径”=“应用目录路径”+“文件/目录名” -通过上述接口获取到应用目录路径dir，文件名为“xxx.txt”，文件所在绝对路径为： +通过上述接口获取到应用目录路径dir，文件名为“xxx.txt”，文件所在应用沙箱路径为： ```js let path = dir + "/xxx.txt"; @@ -43,9 +43,9 @@ stat(path: string): Promise<Stat> **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------- | - | path | string | 是 | 待获取文件的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待获取文件的应用沙箱路径。 | **返回值：** @@ -72,10 +72,10 @@ stat(path:string, callback:AsyncCallback<Stat>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------------------- | ---- | --------------- | - | path | string | 是 | 待获取文件的绝对路径。 | - | callback | AsyncCallback<[Stat](#stat)> | 是 | 异步获取文件的信息之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------- | ---- | ------------------------------ | +| path | string | 是 | 待获取文件的应用沙箱路径。 | +| callback | AsyncCallback<[Stat](#stat)> | 是 | 异步获取文件的信息之后的回调。 | **示例：** ```js @@ -94,9 +94,9 @@ statSync(path:string): Stat **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------- | - | path | string | 是 | 待获取文件的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待获取文件的应用沙箱路径。 | **返回值：** @@ -120,9 +120,9 @@ opendir(path: string): Promise<Dir> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ------------- | - | path | string | 是 | 待打开文件目录的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------ | +| path | string | 是 | 待打开文件目录的应用沙箱路径。 | **返回值：** | 类型 | 说明 | @@ -149,10 +149,10 @@ opendir(path: string, callback: AsyncCallback<Dir>): void **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------------------------------- | ---- | -------------- | - | path | string | 是 | 待打开文件目录的绝对路径。 | - | callback | AsyncCallback<[Dir](#dir)> | 是 | 异步打开文件目录之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------- | ---- | ------------------------------ | +| path | string | 是 | 待打开文件目录的应用沙箱路径。 | +| callback | AsyncCallback<[Dir](#dir)> | 是 | 异步打开文件目录之后的回调。 | **示例：** ```js @@ -174,9 +174,9 @@ opendirSync(path: string): Dir **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ------------- | - | path | string | 是 | 待打开文件目录的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------ | +| path | string | 是 | 待打开文件目录的应用沙箱路径。 | **返回值：** | 类型 | 说明 | @@ -201,10 +201,10 @@ access(path: string, mode?: number): Promise<void> **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待访问文件的绝对路径。 | - | mode | number | 否 | 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
确认当前进程是否具有对应权限：
- 0：确认文件是否存在。
- 1：确认当前进程是否具有可执行权限。
- 2：确认当前进程是否具有写权限。
- 4：确认当前进程是否具有读权限。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待访问文件的应用沙箱路径。 | +| mode | number | 否 | 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
确认当前进程是否具有对应权限：
- 0：确认文件是否存在。
- 1：确认当前进程是否具有可执行权限。
- 2：确认当前进程是否具有写权限。
- 4：确认当前进程是否具有读权限。 | **返回值：** | 类型 | 说明 | @@ -230,11 +230,11 @@ access(path: string, mode: number, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ---------------------------------------- | - | path | string | 是 | 待访问文件的绝对路径。 | - | mode | number | 否 | 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
确认当前进程是否具有对应权限：
- 0：确认文件是否存在。
- 1：确认当前进程是否具有可执行权限。
- 2：确认当前进程是否具有写权限。
- 4：确认当前进程是否具有读权限。 | - | callback | AsyncCallback<void> | 是 | 异步检查当前进程是否可访问某文件之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待访问文件的应用沙箱路径。 | +| mode | number | 否 | 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
确认当前进程是否具有对应权限：
- 0：确认文件是否存在。
- 1：确认当前进程是否具有可执行权限。
- 2：确认当前进程是否具有写权限。
- 4：确认当前进程是否具有读权限。 | +| callback | AsyncCallback<void> | 是 | 异步检查当前进程是否可访问某文件之后的回调。 | **示例：** ```js @@ -253,10 +253,10 @@ accessSync(path: string, mode?: number): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待访问文件的绝对路径。 | - | mode | number | 否 | 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
确认当前进程是否具有对应权限：
- 0：确认文件是否存在。
- 1：确认当前进程是否具有可执行权限。
- 2：确认当前进程是否具有写权限。
- 4：确认当前进程是否具有读权限。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待访问文件的应用沙箱路径。 | +| mode | number | 否 | 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
确认当前进程是否具有对应权限：
- 0：确认文件是否存在。
- 1：确认当前进程是否具有可执行权限。
- 2：确认当前进程是否具有写权限。
- 4：确认当前进程是否具有读权限。 | **示例：** ```js @@ -467,10 +467,10 @@ mkdir(path:string, mode?: number): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待创建目录的绝对路径。 | - | mode | number | 否 | 创建目录的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o775。
- 0o775：所有者具有读、写及可执行权限，其余用户具有读及可执行权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待创建目录的应用沙箱路径。 | +| mode | number | 否 | 创建目录的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o775。
- 0o775：所有者具有读、写及可执行权限，其余用户具有读及可执行权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | **返回值：** | 类型 | 说明 | @@ -496,11 +496,11 @@ mkdir(path: string, mode: number, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ---------------------------------------- | - | path | string | 是 | 待创建目录的绝对路径。 | - | mode | number | 否 | 创建目录的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o775。
- 0o775：所有者具有读、写及可执行权限，其余用户具有读及可执行权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | - | callback | AsyncCallback<void> | 是 | 异步创建目录操作完成之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待创建目录的应用沙箱路径。 | +| mode | number | 否 | 创建目录的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o775。
- 0o775：所有者具有读、写及可执行权限，其余用户具有读及可执行权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | +| callback | AsyncCallback<void> | 是 | 异步创建目录操作完成之后的回调。 | **示例：** ```js @@ -519,10 +519,10 @@ mkdirSync(path: string, mode?: number): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待创建目录的绝对路径。 | - | mode | number | 否 | 创建目录的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o775。
- 0o775：所有者具有读、写及可执行权限，其余用户具有读及可执行权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待创建目录的应用沙箱路径。 | +| mode | number | 否 | 创建目录的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o775。
- 0o775：所有者具有读、写及可执行权限，其余用户具有读及可执行权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | **示例：** ```js @@ -539,11 +539,11 @@ open(path: string, flags?: number, mode?: number): Promise<number> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ----- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待打开文件的绝对路径。 | - | flags | number | 否 | 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
- 0o0：只读打开。
- 0o1：只写打开。
- 0o2：读写打开。
同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
- 0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200：如果追加了0o100选项，且文件已经存在，则出错。
- 0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
- 0o2000：以追加方式打开，后续写将追加到文件末尾。
- 0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。
- 0o200000：如果path指向目录，则出错。
- 0o400000：如果path指向符号链接，则出错。
- 0o4010000：以同步IO的方式打开文件。 | - | mode | number | 否 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o666。
- 0o666：所有者具有读、写权限，所有用户组具有读、写权限，其余用户具有读、写权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待打开文件的应用沙箱路径。 | +| flags | number | 否 | 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
- 0o0：只读打开。
- 0o1：只写打开。
- 0o2：读写打开。
同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
- 0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200：如果追加了0o100选项，且文件已经存在，则出错。
- 0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
- 0o2000：以追加方式打开，后续写将追加到文件末尾。
- 0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。
- 0o200000：如果path指向目录，则出错。
- 0o400000：如果path指向符号链接，则出错。
- 0o4010000：以同步IO的方式打开文件。 | +| mode | number | 否 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o666。
- 0o666：所有者具有读、写权限，所有用户组具有读、写权限，其余用户具有读、写权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | **返回值：** | 类型 | 说明 | @@ -569,12 +569,12 @@ open(path: string, flags: number, mode: number, callback: AsyncCallback<numbe **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------------- | ---- | ---------------------------------------- | - | path | string | 是 | 待打开文件的绝对路径。 | - | flags | number | 是 | 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
- 0o0：只读打开。
- 0o1：只写打开。
- 0o2：读写打开。
同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
- 0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200：如果追加了0o100选项，且文件已经存在，则出错。
- 0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
- 0o2000：以追加方式打开，后续写将追加到文件末尾。
- 0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。
- 0o200000：如果path指向目录，则出错。
- 0o400000：如果path指向符号链接，则出错。
- 0o4010000：以同步IO的方式打开文件。 | - | mode | number | 是 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o666。
- 0o666：所有者具有读、写权限，所有用户组具有读、写权限，其余用户具有读、写权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | - | callback | AsyncCallback <void> | 是 | 异步打开文件之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------- | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待打开文件的应用沙箱路径。 | +| flags | number | 是 | 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
- 0o0：只读打开。
- 0o1：只写打开。
- 0o2：读写打开。
同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
- 0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200：如果追加了0o100选项，且文件已经存在，则出错。
- 0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
- 0o2000：以追加方式打开，后续写将追加到文件末尾。
- 0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。
- 0o200000：如果path指向目录，则出错。
- 0o400000：如果path指向符号链接，则出错。
- 0o4010000：以同步IO的方式打开文件。 | +| mode | number | 是 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o666。
- 0o666：所有者具有读、写权限，所有用户组具有读、写权限，其余用户具有读、写权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | +| callback | AsyncCallback <void> | 是 | 异步打开文件之后的回调。 | **示例：** ```js @@ -593,11 +593,11 @@ openSync(path:string, flags?:number, mode?:number): number **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ----- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待打开文件的绝对路径。 | - | flags | number | 否 | 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
- 0o0：只读打开。
- 0o1：只写打开。
- 0o2：读写打开。
同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
- 0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200：如果追加了0o100选项，且文件已经存在，则出错。
- 0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
- 0o2000：以追加方式打开，后续写将追加到文件末尾。
- 0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。
- 0o200000：如果path指向目录，则出错。
- 0o400000：如果path指向符号链接，则出错。
- 0o4010000：以同步IO的方式打开文件。 | - | mode | number | 否 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o666。
- 0o666：所有者具有读、写权限，所有用户组具有读、写权限，其余用户具有读、写权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。
创建出的文件权限受umask影响，umask随进程启动确定，其修改当前不开放。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待打开文件的应用沙箱路径。 | +| flags | number | 否 | 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
- 0o0：只读打开。
- 0o1：只写打开。
- 0o2：读写打开。
同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
- 0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200：如果追加了0o100选项，且文件已经存在，则出错。
- 0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
- 0o2000：以追加方式打开，后续写将追加到文件末尾。
- 0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。
- 0o200000：如果path指向目录，则出错。
- 0o400000：如果path指向符号链接，则出错。
- 0o4010000：以同步IO的方式打开文件。 | +| mode | number | 否 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o666。
- 0o666：所有者具有读、写权限，所有用户组具有读、写权限，其余用户具有读、写权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。
创建出的文件权限受umask影响，umask随进程启动确定，其修改当前不开放。 | **返回值：** | 类型 | 说明 | @@ -722,9 +722,9 @@ rmdir(path: string): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------- | - | path | string | 是 | 待删除目录的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待删除目录的应用沙箱路径。 | **返回值：** | 类型 | 说明 | @@ -750,10 +750,10 @@ rmdir(path: string, callback:AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ------------ | - | path | string | 是 | 待删除目录的绝对路径。 | - | callback | AsyncCallback<void> | 是 | 异步删除目录之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | -------------------------- | +| path | string | 是 | 待删除目录的应用沙箱路径。 | +| callback | AsyncCallback<void> | 是 | 异步删除目录之后的回调。 | **示例：** ```js @@ -773,9 +773,9 @@ rmdirSync(path: string): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------- | - | path | string | 是 | 待删除目录的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待删除目录的应用沙箱路径。 | **示例：** ```js @@ -792,9 +792,9 @@ unlink(path:string): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------- | - | path | string | 是 | 待删除文件的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待删除文件的应用沙箱路径。 | **返回值：** | 类型 | 说明 | @@ -820,10 +820,10 @@ unlink(path:string, callback:AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ------------ | - | path | string | 是 | 待删除文件的绝对路径。 | - | callback | AsyncCallback<void> | 是 | 异步删除文件之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | -------------------------- | +| path | string | 是 | 待删除文件的应用沙箱路径。 | +| callback | AsyncCallback<void> | 是 | 异步删除文件之后的回调。 | **示例：** ```js @@ -842,9 +842,9 @@ unlinkSync(path: string): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------- | - | path | string | 是 | 待删除文件的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待删除文件的应用沙箱路径。 | **示例：** ```js @@ -961,10 +961,10 @@ hash(path: string, algorithm: string): Promise<string> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | --------- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待计算哈希值文件的绝对路径。 | - | algorithm | string | 是 | 哈希计算采用的算法。可选 "md5"、"sha1" 或 "sha256"。建议采用安全强度更高的 "sha256"。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待计算哈希值文件的应用沙箱路径。 | +| algorithm | string | 是 | 哈希计算采用的算法。可选 "md5"、"sha1" 或 "sha256"。建议采用安全强度更高的 "sha256"。 | **返回值：** | 类型 | 说明 | @@ -990,11 +990,11 @@ hash(path: string, algorithm: string, callback: AsyncCallback<string>): vo **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | --------- | --------------------------- | ---- | ---------------------------------------- | - | path | string | 是 | 待计算哈希值文件的绝对路径。 | - | algorithm | string | 是 | 哈希计算采用的算法。可选 "md5"、"sha1" 或 "sha256"。建议采用安全强度更高的 "sha256"。 | - | callback | AsyncCallback<string> | 是 | 异步计算文件哈希操之后的回调函数（其中给定文件哈希值表示为十六进制数字串，所有字母均大写）。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | --------------------------- | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待计算哈希值文件的应用沙箱路径。 | +| algorithm | string | 是 | 哈希计算采用的算法。可选 "md5"、"sha1" 或 "sha256"。建议采用安全强度更高的 "sha256"。 | +| callback | AsyncCallback<string> | 是 | 异步计算文件哈希操之后的回调函数（其中给定文件哈希值表示为十六进制数字串，所有字母均大写）。 | **示例：** ```js @@ -1015,10 +1015,10 @@ chmod(path: string, mode: number):Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待改变文件权限的绝对路径。 | - | mode | number | 是 | 改变文件权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待改变文件权限的应用沙箱路径。 | +| mode | number | 是 | 改变文件权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | **返回值：** | 类型 | 说明 | @@ -1044,11 +1044,11 @@ chmod(path: string, mode: number, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ---------------------------------------- | - | path | string | 是 | 待改变文件权限的绝对路径。 | - | mode | number | 是 | 改变文件权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | - | callback | AsyncCallback<void> | 是 | 异步改变文件权限之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待改变文件权限的应用沙箱路径。 | +| mode | number | 是 | 改变文件权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | +| callback | AsyncCallback<void> | 是 | 异步改变文件权限之后的回调。 | **示例：** ```js @@ -1067,10 +1067,10 @@ chmodSync(path: string, mode: number): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待改变文件权限的绝对路径。 | - | mode | number | 是 | 改变文件权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待改变文件权限的应用沙箱路径。 | +| mode | number | 是 | 改变文件权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | **示例：** ```js @@ -1236,10 +1236,10 @@ truncate(path: string, len?: number): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------- | - | path | string | 是 | 待截断文件的绝对路径。 | - | len | number | 是 | 文件截断后的长度，以字节为单位。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------------- | +| path | string | 是 | 待截断文件的应用沙箱路径。 | +| len | number | 是 | 文件截断后的长度，以字节为单位。 | **返回值：** | 类型 | 说明 | @@ -1265,11 +1265,11 @@ truncate(path: string, len: number, callback:AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ---------------- | - | path | string | 是 | 待截断文件的绝对路径。 | - | len | number | 是 | 文件截断后的长度，以字节为单位。 | - | callback | AsyncCallback<void> | 是 | 异步截断文件的信息之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | -------------------------------- | +| path | string | 是 | 待截断文件的应用沙箱路径。 | +| len | number | 是 | 文件截断后的长度，以字节为单位。 | +| callback | AsyncCallback<void> | 是 | 异步截断文件的信息之后的回调。 | **示例：** ```js @@ -1288,10 +1288,10 @@ truncateSync(path: string, len?: number): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------- | - | path | string | 是 | 待截断文件的绝对路径。 | - | len | number | 否 | 文件截断后的长度，以字节为单位。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------------- | +| path | string | 是 | 待截断文件的应用沙箱路径。 | +| len | number | 否 | 文件截断后的长度，以字节为单位。 | **示例：** ```js @@ -1312,10 +1312,10 @@ readText(filePath: string, options?: { **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------ | ---- | ---------------------------------------- | - | filePath | string | 是 | 待读取文件的绝对路径。 | - | options | Object | 否 | 支持如下选项：
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 'utf-8'，仅支持 'utf-8'。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ------------------------------------------------------------ | +| filePath | string | 是 | 待读取文件的应用沙箱路径。 | +| options | Object | 否 | 支持如下选项：
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 'utf-8'，仅支持 'utf-8'。 | **返回值：** | 类型 | 说明 | @@ -1345,11 +1345,11 @@ readText(filePath: string, options: { **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | --------------------------- | ---- | ---------------------------------------- | - | filePath | string | 是 | 待读取文件的绝对路径。 | - | options | Object | 否 | 支持如下选项：
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 'utf-8'，仅支持 'utf-8'。 | - | callback | AsyncCallback<string> | 是 | 异步通过文本方式读取文件之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ------------------------------------------------------------ | +| filePath | string | 是 | 待读取文件的应用沙箱路径。 | +| options | Object | 否 | 支持如下选项：
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 'utf-8'，仅支持 'utf-8'。 | +| callback | AsyncCallback<string> | 是 | 异步通过文本方式读取文件之后的回调。 | **示例：** ```js @@ -1372,10 +1372,10 @@ readTextSync(filePath: string, options?: { **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------ | ---- | ---------------------------------------- | - | filePath | string | 是 | 待读取文件的绝对路径。 | - | options | Object | 否 | 支持如下选项：
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 'utf-8'，仅支持 'utf-8'。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ------------------------------------------------------------ | +| filePath | string | 是 | 待读取文件的应用沙箱路径。 | +| options | Object | 否 | 支持如下选项：
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 'utf-8'，仅支持 'utf-8'。 | **返回值：** | 类型 | 说明 | @@ -1397,9 +1397,9 @@ lstat(path: string): Promise<Stat> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------------- | - | path | string | 是 | 目标文件的绝对路径，指向链接状态。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------------------- | +| path | string | 是 | 目标文件的应用沙箱路径，指向链接状态。 | **返回值：** | 类型 | 说明 | @@ -1425,10 +1425,10 @@ lstat(path:string, callback:AsyncCallback<Stat>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------------------- | ---- | ----------------- | - | path | string | 是 | 目标文件的绝对路径，指向链接状态。 | - | callback | AsyncCallback<[Stat](#stat)> | 是 | 异步获取链接状态信息之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------- | ---- | -------------------------------------- | +| path | string | 是 | 目标文件的应用沙箱路径，指向链接状态。 | +| callback | AsyncCallback<[Stat](#stat)> | 是 | 异步获取链接状态信息之后的回调。 | **示例：** ```js @@ -1447,9 +1447,9 @@ lstatSync(path:string): Stat **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------------- | - | path | string | 是 | 目标文件的绝对路径，指向链接状态。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------------------- | +| path | string | 是 | 目标文件的应用沙箱路径，指向链接状态。 | **返回值：** | 类型 | 说明 | @@ -1536,10 +1536,10 @@ rename(oldPath: string, newPath: string): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ------ | ---- | ------------------------ | - | oldPath | string | 是 | 目标文件的当前绝对路径。 | - | newPath | String | 是 | 目标文件的新绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ---------------------------- | +| oldPath | string | 是 | 目标文件的当前应用沙箱路径。 | +| newPath | String | 是 | 目标文件的新应用沙箱路径。 | **返回值：** | 类型 | 说明 | @@ -1565,11 +1565,11 @@ rename(oldPath: string, newPath: string, callback: AsyncCallback<void>): v **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ------------- | - | oldPath | string | 是 | 目标文件的当前绝对路径。 | - | newPath | String | 是 | 目标文件的新绝对路径。 | - | Callback | AsyncCallback<void> | 是 | 异步重命名文件之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ---------------------------- | +| oldPath | string | 是 | 目标文件的当前应用沙箱路径。 | +| newPath | String | 是 | 目标文件的新应用沙箱路径。 | +| Callback | AsyncCallback<void> | 是 | 异步重命名文件之后的回调。 | **示例：** ```js @@ -1587,10 +1587,10 @@ renameSync(oldPath: string, newPath: string): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ------ | ---- | ------------ | - | oldPath | string | 是 | 目标文件的当前绝对路径。 | - | newPath | String | 是 | 目标文件的新绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ---------------------------- | +| oldPath | string | 是 | 目标文件的当前应用沙箱路径。 | +| newPath | String | 是 | 目标文件的新应用沙箱路径。 | **示例：** ```js @@ -1745,10 +1745,10 @@ symlink(target: string, srcPath: string): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ------ | ---- | ------------ | - | target | string | 是 | 目标文件的绝对路径。 | - | srcPath | string | 是 | 符号链接文件的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ---------------------------- | +| target | string | 是 | 目标文件的应用沙箱路径。 | +| srcPath | string | 是 | 符号链接文件的应用沙箱路径。 | **返回值：** | 类型 | 说明 | @@ -1774,11 +1774,11 @@ symlink(target: string, srcPath: string, callback: AsyncCallback<void>): v **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ---------------- | - | target | string | 是 | 目标文件的绝对路径。 | - | srcPath | string | 是 | 符号链接文件的绝对路径。 | - | callback | AsyncCallback<void> | 是 | 异步创建符号链接信息之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | -------------------------------- | +| target | string | 是 | 目标文件的应用沙箱路径。 | +| srcPath | string | 是 | 符号链接文件的应用沙箱路径。 | +| callback | AsyncCallback<void> | 是 | 异步创建符号链接信息之后的回调。 | **示例：** ```js @@ -1797,10 +1797,10 @@ symlinkSync(target: string, srcPath: string): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ------ | ---- | ------------ | - | target | string | 是 | 目标文件的绝对路径。 | - | srcPath | string | 是 | 符号链接文件的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ---------------------------- | +| target | string | 是 | 目标文件的应用沙箱路径。 | +| srcPath | string | 是 | 符号链接文件的应用沙箱路径。 | **示例：** ```js @@ -1817,11 +1817,11 @@ chown(path: string, uid: number, gid: number): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | --------------- | - | path | string | 是 | 待改变文件的绝对路径。 | - | uid | number | 是 | 新的UID（UserID）。 | - | gid | number | 是 | 新的GID（GroupID）。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待改变文件的应用沙箱路径。 | +| uid | number | 是 | 新的UID（UserID）。 | +| gid | number | 是 | 新的GID（GroupID）。 | **返回值：** | 类型 | 说明 | @@ -1848,12 +1848,12 @@ chown(path: string, uid: number, gid: number, callback: AsyncCallback<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | --------------- | - | path | string | 是 | 待改变文件的绝对路径。 | - | uid | number | 是 | 新的UID。 | - | gid | number | 是 | 新的GID。 | - | callback | AsyncCallback<void> | 是 | 异步改变文件所有者之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------ | +| path | string | 是 | 待改变文件的应用沙箱路径。 | +| uid | number | 是 | 新的UID。 | +| gid | number | 是 | 新的GID。 | +| callback | AsyncCallback<void> | 是 | 异步改变文件所有者之后的回调。 | **示例：** ```js @@ -1873,11 +1873,11 @@ chownSync(path: string, uid: number, gid: number): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------- | - | path | string | 是 | 待改变文件的绝对路径。 | - | uid | number | 是 | 新的UID。 | - | gid | number | 是 | 新的GID。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待改变文件的应用沙箱路径。 | +| uid | number | 是 | 新的UID。 | +| gid | number | 是 | 新的GID。 | **示例：** ```js @@ -2041,10 +2041,10 @@ createStream(path: string, mode: string): Promise<Stream> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待打开文件的绝对路径。 | - | mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待打开文件的应用沙箱路径。 | +| mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | **返回值：** | 类型 | 说明 | @@ -2070,11 +2070,11 @@ createStream(path: string, mode: string, callback: AsyncCallback<Stream>): **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | --------------------------------------- | ---- | ---------------------------------------- | - | path | string | 是 | 待打开文件的绝对路径。 | - | mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | - | callback | AsyncCallback<[Stream](#stream7)> | 是 | 异步打开文件流之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待打开文件的应用沙箱路径。 | +| mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | +| callback | AsyncCallback<[Stream](#stream7)> | 是 | 异步打开文件流之后的回调。 | **示例：** ```js @@ -2093,10 +2093,10 @@ createStreamSync(path: string, mode: string): Stream **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待打开文件的绝对路径。 | - | mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待打开文件的应用沙箱路径。 | +| mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | **返回值：** | 类型 | 说明 | @@ -2273,11 +2273,11 @@ lchown(path: string, uid: number, gid: number): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------- | - | path | string | 是 | 待打开文件的绝对路径。 | - | uid | number | 是 | 新的UID。 | - | gid | number | 是 | 新的GID。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待打开文件的应用沙箱路径。 | +| uid | number | 是 | 新的UID。 | +| gid | number | 是 | 新的GID。 | **返回值：** | 类型 | 说明 | @@ -2304,12 +2304,12 @@ lchown(path: string, uid: number, gid: number, callback: AsyncCallback<void&g **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | --------------- | - | path | string | 是 | 待打开文件的绝对路径。 | - | uid | number | 是 | 新的UID。 | - | gid | number | 是 | 新的GID。 | - | callback | AsyncCallback<void> | 是 | 异步改变文件所有者之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------ | +| path | string | 是 | 待打开文件的应用沙箱路径。 | +| uid | number | 是 | 新的UID。 | +| gid | number | 是 | 新的GID。 | +| callback | AsyncCallback<void> | 是 | 异步改变文件所有者之后的回调。 | **示例：** ```js @@ -2329,11 +2329,11 @@ lchownSync(path: string, uid: number, gid: number): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------- | - | path | string | 是 | 待打开文件的绝对路径。 | - | uid | number | 是 | 新的UID。 | - | gid | number | 是 | 新的GID。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待打开文件的应用沙箱路径。 | +| uid | number | 是 | 新的UID。 | +| gid | number | 是 | 新的GID。 | **示例：** ```js @@ -2351,11 +2351,11 @@ createWatcher(filename: string, events: number, callback: AsyncCallback<numbe **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | --------------------------------- | ---- | ---------------------------------------- | - | filename | string | 是 | 待监视文件的绝对路径。 | - | events | Number | 是 | - 1: 监听文件或者目录是否发生重命名。
- 2：监听文件或者目录内容的是否修改。
- 3：两者都有。 | - | callback | AsyncCallback<number > | 是 | 每发生变化一次，调用一次此函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------- | ---- | ------------------------------------------------------------ | +| filename | string | 是 | 待监视文件的应用沙箱路径。 | +| events | Number | 是 | - 1: 监听文件或者目录是否发生重命名。
- 2：监听文件或者目录内容的是否修改。
- 3：两者都有。 | +| callback | AsyncCallback<number > | 是 | 每发生变化一次，调用一次此函数。 | **返回值：** | 类型 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md index 84b57e67329a954977f3d371f57b698c016c5296..797fca697daa77332a9c5eb22bc392a93c11cd25 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -2237,11 +2237,11 @@ async function example() { **系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core -| 名称 | 类型 | 必填 | 描述 | -| ------------ | ------ | ---- | ---------------------------------------- | -| src | string | 是 | 应用本地文件绝对路径。 | -| mimeType | string | 是 | 媒体MIME（Multipurpose Internet Mail Extensions）类型。
包括：'image/\*'、'video/\*'、'audio/\*'、 'file\*'。 | -| relativePath | string | 否 | 自定义媒体资源保存位置，例：Pictures/ 不填则保存到默认路径。
image类型默认路径Pictures/
video类型默认路径Videos/
audio类型默认路径Audios/
file类型默认路径Documents/ 。 | +| 名称 | 类型 | 必填 | 描述 | +| ------------ | ------ | ---- | ------------------------------------------------------------ | +| src | string | 是 | 本地文件应用沙箱路径。 | +| mimeType | string | 是 | 媒体MIME（Multipurpose Internet Mail Extensions）类型。
包括：'image/\*'、'video/\*'、'audio/\*'、 'file\*'。 | +| relativePath | string | 否 | 自定义媒体资源保存位置，例：Pictures/ 不填则保存到默认路径。
image类型默认路径Pictures/
video类型默认路径Videos/
audio类型默认路径Audios/
file类型默认路径Documents/ 。 | ## MediaSelectOption(deprecated) diff --git a/zh-cn/application-dev/reference/apis/js-apis-securityLabel.md b/zh-cn/application-dev/reference/apis/js-apis-securityLabel.md index 8138d844a602118b83de7857efac46f098d5754b..9c5df1940acdca9c8c68801b3539d924ee473c48 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-securityLabel.md +++ b/zh-cn/application-dev/reference/apis/js-apis-securityLabel.md @@ -13,11 +13,11 @@ import securityLabel from '@ohos.securityLabel'; ## 使用说明 -使用该功能模块对文件/目录进行操作前，需要先获取其绝对路径，获取方式及其接口用法请参考：[Context模块的接口getOrCreateLocalDir](js-apis-Context.md)。 +使用该功能模块对文件/目录进行操作前，需要先获取其应用沙箱路径，获取方式及其接口用法请参考：[Context模块的接口getOrCreateLocalDir](js-apis-Context.md)。 -“文件/目录绝对路径”=“应用目录路径”+“文件/目录名” +“文件/目录应用沙箱路径”=“应用目录路径”+“文件/目录名” -通过上述接口获取到应用目录路径dir，文件名为“xxx.txt”，文件所在绝对路径为： +通过上述接口获取到应用目录路径dir，文件名为“xxx.txt”，文件所在应用沙箱路径为： ```js let path = dir + "/xxx.txt"; diff --git a/zh-cn/application-dev/reference/apis/js-apis-statfs.md b/zh-cn/application-dev/reference/apis/js-apis-statfs.md index 31ebb1e04290ce9d962d6aed2fa7feb625ec2a0b..fb5a81bd330d1e919c282620af2932e024e0091f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-statfs.md +++ b/zh-cn/application-dev/reference/apis/js-apis-statfs.md @@ -13,11 +13,11 @@ import statfs from '@ohos.statfs'; ## 使用说明 -使用该功能模块对文件/目录进行操作前，需要先获取其绝对路径，获取方式及其接口用法请参考：[Context模块的接口getOrCreateLocalDir](js-apis-Context.md)。 +使用该功能模块对文件/目录进行操作前，需要先获取其应用沙箱路径，获取方式及其接口用法请参考：[Context模块的接口getOrCreateLocalDir](js-apis-Context.md)。 -“文件/目录绝对路径”=“应用目录路径”+“文件/目录名” +“文件/目录应用沙箱路径”=“应用目录路径”+“文件/目录名” -通过上述接口获取到应用目录路径dir，以文件名“xxx.txt”为例，文件所在绝对路径为： +通过上述接口获取到应用目录路径dir，以文件名“xxx.txt”为例，文件所在应用沙箱路径为： ```js let path = dir + "xxx.txt";