该模块提供卷设备、磁盘设备查询和管理的相关功能:包括查询卷设备信息,对卷设备的挂载卸载、对磁盘设备分区以及卷设备的格式化等功能。
说明:
- 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
- 本模块接口为系统接口。
导入模块
import volumemanager from "@ohos.file.volumeManager";
volumemanager.getAllVolumes
getAllVolumes(): Promise<Array<Volume>>
异步获取当前外置存储中所有卷设备信息,以promise方式返回。
需要权限:ohos.permission.STORAGE_MANAGER
系统能力:SystemCapability.FileManagement.StorageService.Volume
返回值:
类型 | 说明 |
---|---|
Promise<Volume[]> | Promise对象,返回当前所有可获得的卷设备信息 |
错误码:
以下错误码的详细介绍请参见文件管理错误码。
错误码ID | 错误信息 |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | The input parameter is invalid. |
13600001 | IPC error. |
13900042 | Unknown error. |
示例:
import { BusinessError } from '@ohos.base';
volumemanager.getAllVolumes().then((volumes: Array<volumemanager.Volume>) => {
// do something with volumes, which is an array
}).catch((error: BusinessError) => {
console.info("getAllVolumes failed");
});
volumemanager.getAllVolumes
getAllVolumes(callback: AsyncCallback<Array<Volume>>): void
异步获取当前外置存储中所有卷设备信息,以callback方式返回。
需要权限:ohos.permission.STORAGE_MANAGER
系统能力:SystemCapability.FileManagement.StorageService.Volume
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
回调 | AsyncCallback<Volume[]> | 是 | 获取当前所有可获得的卷设备信息之后的回调 |
错误码:
以下错误码的详细介绍请参见文件管理错误码。
错误码ID | 错误信息 |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | The input parameter is invalid. |
13600001 | IPC error. |
13900042 | Unknown error. |
示例:
import { BusinessError } from '@ohos.base';
volumemanager.getAllVolumes((error: BusinessError, volumes: Array<volumemanager.Volume>) => {
// do something
});
volumemanager.mount
mount(volumeId: string): Promise<void>
异步挂载指定卷设备,以promise方式返回。当前仅支持vfat、exfat以及ntfs三种文件系统的卷设备挂载。
需要权限:ohos.permission.MOUNT_UNMOUNT_MANAGER
系统能力:SystemCapability.FileManagement.StorageService.Volume
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
volumeId | string | 是 | 卷设备id |
返回值:
类型 | 说明 |
---|---|
Promise<void> | 无返回结果的Promise对象 |
错误码:
以下错误码的详细介绍请参见文件管理错误码。
错误码ID | 错误信息 |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | The input parameter is invalid. |
13600001 | IPC error. |
13600002 | Not supported filesystem. |
13600003 | Failed to mount. |
13600005 | Incorrect volume state. |
13600008 | No such object. |
13900042 | Unknown error. |
示例:
import { BusinessError } from '@ohos.base';
let volumeId: string = "";
volumemanager.mount(volumeId).then(() => {
// do something
}).catch((error: BusinessError) => {
console.info("mount failed");
});
volumemanager.mount
mount(volumeId: string, callback:AsyncCallback<void>):void
异步挂载指定卷设备,以callback方式返回。当前仅支持vfat、exfat以及ntfs三种文件系统的卷设备挂载。
需要权限:ohos.permission.MOUNT_UNMOUNT_MANAGER
系统能力:SystemCapability.FileManagement.StorageService.Volume
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
volumeId | 字符串 | 是 | 卷设备id |
回调 | AsyncCallback<void> | 是 | 挂载指定卷设备之后的回调 |
错误码:
以下错误码的详细介绍请参见文件管理错误码。
错误码ID | 错误信息 |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | The input parameter is invalid. |
13600001 | IPC error. |
13600002 | Not supported filesystem. |
13600003 | Failed to mount. |
13600005 | Incorrect volume state. |
13600008 | No such object. |
13900042 | Unknown error. |
示例:
import { BusinessError } from '@ohos.base';
let volumeId: string = "";
volumemanager.mount(volumeId, (error: BusinessError) => {
// do something
});
volumemanager.unmount
unmount(volumeId: string): Promise<void>
异步卸载指定卷设备,以promise方式返回。
需要权限:ohos.permission.MOUNT_UNMOUNT_MANAGER
系统能力:SystemCapability.FileManagement.StorageService.Volume
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
volumeId | string | 是 | 卷设备id |
返回值:
类型 | 说明 |
---|---|
Promise<void> | 无返回结果的Promise对象 |
错误码:
以下错误码的详细介绍请参见文件管理错误码。
错误码ID | 错误信息 |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | The input parameter is invalid. |
13600001 | IPC error. |
13600002 | Not supported filesystem. |
13600004 | Failed to unmount. |
13600005 | Incorrect volume state. |
13600008 | No such object. |
13900042 | Unknown error. |
示例:
import { BusinessError } from '@ohos.base';
let volumeId: string = "";
volumemanager.unmount(volumeId).then(() => {
// do something
}).catch((error: BusinessError) => {
console.info("mount failed");
});
volumemanager.unmount
unmount(volumeId: string, callback: AsyncCallback<void>): void
异步卸载指定卷设备,以callback方式返回。
需要权限:ohos.permission.MOUNT_UNMOUNT_MANAGER
系统能力:SystemCapability.FileManagement.StorageService.Volume
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
volumeId | string | 是 | 卷设备id |
callback | AsyncCallback<void> | 是 | 卸载指定卷设备之后的回调 |
错误码:
以下错误码的详细介绍请参见文件管理错误码。
错误码ID | 错误信息 |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | The input parameter is invalid. |
13600001 | IPC error. |
13600002 | Not supported filesystem. |
13600004 | Failed to unmount. |
13600005 | Incorrect volume state. |
13600008 | No such object. |
13900042 | Unknown error. |
示例:
import { BusinessError } from '@ohos.base';
let volumeId: string = "";
volumemanager.unmount(volumeId, (error: BusinessError) => {
// do something
});
volumemanager.getVolumeByUuid
getVolumeByUuid(uuid: string): Promise<Volume>
异步通过卷设备uuid获得指定卷设备信息,以promise方式返回。
需要权限:ohos.permission.STORAGE_MANAGER
系统能力:SystemCapability.FileManagement.StorageService.Volume
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
uuid | string | 是 | 卷设备uuid |
返回值:
类型 | 说明 |
---|---|
Promise<Volume> | Promise对象,返回当前所有可获得的卷设备信息 |
错误码:
以下错误码的详细介绍请参见文件管理错误码。
错误码ID | 错误信息 |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | The input parameter is invalid. |
13600001 | IPC error. |
13600008 | No such object. |
13900042 | Unknown error. |
示例:
import { BusinessError } from '@ohos.base';
let uuid: string = "";
volumemanager.getVolumeByUuid(uuid).then((volume: volumemanager.Volume) => {
console.info("getVolumeByUuid successfully:" + JSON.stringify(volume));
}).catch((error: BusinessError) => {
console.info("getVolumeByUuid failed with error:" + JSON.stringify(error));
});
volumemanager.getVolumeByUuid
getVolumeByUuid(uuid: string, callback: AsyncCallback<Volume>): void
异步通过卷设备uuid获得指定卷设备信息,以callback方式返回。
需要权限:ohos.permission.STORAGE_MANAGER
系统能力:SystemCapability.FileManagement.StorageService.Volume
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
uuid | string | 是 | 卷设备uuid |
callback | AsyncCallback<Volume> | 是 | 获取卷设备信息之后的回调 |
错误码:
以下错误码的详细介绍请参见文件管理错误码。
错误码ID | 错误信息 |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | The input parameter is invalid. |
13600001 | IPC error. |
13600008 | No such object. |
13900042 | Unknown error. |
示例:
import { BusinessError } from '@ohos.base';
let uuid: string = "";
volumemanager.getVolumeByUuid(uuid, (error: BusinessError, volume: volumemanager.Volume) => {
// do something
});
volumemanager.getVolumeById
getVolumeById(volumeId: string): Promise<Volume>
异步通过卷设备id获得指定卷设备信息,以promise方式返回。
需要权限:ohos.permission.STORAGE_MANAGER
系统能力:SystemCapability.FileManagement.StorageService.Volume
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
volumeId | string | 是 | 卷设备id |
返回值:
类型 | 说明 |
---|---|
Promise<Volume> | Promise对象,返回当前所有可获得的卷设备信息 |
错误码:
以下错误码的详细介绍请参见文件管理错误码。
错误码ID | 错误信息 |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | The input parameter is invalid. |
13600001 | IPC error. |
13600008 | No such object. |
13900042 | Unknown error. |
示例:
import { BusinessError } from '@ohos.base';
let volumeId: string = "";
volumemanager.getVolumeById(volumeId).then((volume: volumemanager.Volume) => {
console.info("getVolumeById successfully:" + JSON.stringify(volume));
}).catch((error: BusinessError) => {
console.info("getVolumeById failed with error:" + JSON.stringify(error));
});
volumemanager.getVolumeById
getVolumeById(volumeId: string, callback: AsyncCallback<Volume>): void
异步通过指定卷设备id获得卷设备信息,以callback方式返回。
需要权限:ohos.permission.STORAGE_MANAGER
系统能力:SystemCapability.FileManagement.StorageService.Volume
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
volumeId | string | 是 | 卷设备id |
callback | AsyncCallback<Volume> | 是 | 获取卷设备信息之后的回调 |
错误码:
以下错误码的详细介绍请参见文件管理错误码。
错误码ID | 错误信息 |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | The input parameter is invalid. |
13600001 | IPC error. |
13600008 | No such object. |
13900042 | Unknown error. |
示例:
import { BusinessError } from '@ohos.base';
let volumeId: string = "";
volumemanager.getVolumeById(volumeId, (error: BusinessError, volume: volumemanager.Volume) => {
// do something
});
volumemanager.setVolumeDescription
setVolumeDescription(uuid: string, description: string): Promise<void>
异步修改指定卷设备描述,以promise方式返回。
需要权限:ohos.permission.MOUNT_UNMOUNT_MANAGER
系统能力:SystemCapability.FileManagement.StorageService.Volume
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
uuid | string | 是 | 卷设备uuid |
description | string | 是 | 卷设备描述 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | 无返回结果的Promise对象 |
错误码:
以下错误码的详细介绍请参见文件管理错误码。
错误码ID | 错误信息 |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | The input parameter is invalid. |
13600001 | IPC error. |
13600002 | Not supported filesystem. |
13600005 | Incorrect volume state. |
13600008 | No such object. |
13900042 | Unknown error. |
示例:
import { BusinessError } from '@ohos.base';
let uuid: string = "";
let description: string = "";
volumemanager.setVolumeDescription(uuid, description).then(() => {
console.info("setVolumeDescription successfully");
}).catch((error: BusinessError) => {
console.info("setVolumeDescription failed with error:" + JSON.stringify(error));
});
volumemanager.setVolumeDescription
setVolumeDescription(uuid: string, description: string, callback: AsyncCallback<void>): void
异步修改指定卷设备描述,以callback方式返回。
需要权限:ohos.permission.MOUNT_UNMOUNT_MANAGER
系统能力:SystemCapability.FileManagement.StorageService.Volume
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
uuid | string | 是 | 卷设备uuid |
description | string | 是 | 卷设备描述 |
callback | AsyncCallback<void> | 是 | 设置卷描述之后的回调 |
错误码:
以下错误码的详细介绍请参见文件管理错误码。
错误码ID | 错误信息 |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | The input parameter is invalid. |
13600001 | IPC error. |
13600002 | Not supported filesystem. |
13600005 | Incorrect volume state. |
13600008 | No such object. |
13900042 | Unknown error. |
示例:
import { BusinessError } from '@ohos.base';
let uuid: string = "";
let description: string = "";
volumemanager.setVolumeDescription(uuid, description, (error: BusinessError) => {
// do something
});
volumemanager.format
format(volumeId: string, fsType: string): Promise<void>
异步对指定卷设备进行格式化,以promise方式返回。当前仅支持vfat和exfat两种文件系统类型的格式化,只有处于卸载状态的卷设备可以进行格式化,格式化后卷设备的uuid、挂载路径和卷设备描述均会发生变化。
需要权限:ohos.permission.MOUNT_FORMAT_MANAGER
系统能力:SystemCapability.FileManagement.StorageService.Volume
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
volumeId | 字符串 | 是 | 卷设备id |
fsType | 字符串 | 是 | 文件系统类型(vfat或者exfat) |
返回值:
类型 | 说明 |
---|---|
承诺<无效> | 无返回结果的Promise对象 |
错误码:
以下错误码的详细介绍请参见文件管理错误码。
错误码ID | 错误信息 |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | The input parameter is invalid. |
13600001 | IPC error. |
13600002 | Not supported filesystem. |
13600005 | Incorrect volume state. |
13600008 | No such object. |
13900042 | Unknown error. |
示例:
import { BusinessError } from '@ohos.base';
let volumeId: string = "";
let fsType: string = "";
volumemanager.format(volumeId, fsType).then(() => {
console.info("format successfully");
}).catch((error: BusinessError) => {
console.info("format failed with error:" + JSON.stringify(error));
});
volumemanager.format
format(volumeId: string, fsType: string, callback: AsyncCallback<void>): void
异步对指定卷设备进行格式化,以callback方式返回。当前仅支持vfat和exfat两种文件系统类型的格式化,只有处于卸载状态的卷设备可以进行格式化,格式化后卷设备的uuid、挂载路径和卷设备描述均会发生变化。
需要权限:ohos.permission.MOUNT_FORMAT_MANAGER
系统能力:SystemCapability.FileManagement.StorageService.Volume
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
volumeId | 字符串 | 是 | 卷设备id |
fsType | 字符串 | 是 | 文件系统类型(vfat或者exfat) |
回调 | AsyncCallback<void> | 是 | 对指定卷设备格式化后的回调 |
错误码:
以下错误码的详细介绍请参见文件管理错误码。
错误码ID | 错误信息 |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | The input parameter is invalid. |
13600001 | IPC error. |
13600002 | Not supported filesystem. |
13600005 | Incorrect volume state. |
13600008 | No such object. |
13900042 | Unknown error. |
示例:
import { BusinessError } from '@ohos.base';
let volumeId: string = "";
let fsType: string = "";
volumemanager.format(volumeId, fsType, (error: BusinessError) => {
// do something
});
volumemanager.partition
partition(diskId: string, type: number): Promise<void>
异步对磁盘设备进行分区,以promise方式返回。当前仅支持将磁盘设备重新分区为一个分区,系统是支持读取多分区的磁盘设备。
需要权限:ohos.permission.MOUNT_FORMAT_MANAGER
系统能力:SystemCapability.FileManagement.StorageService.Volume
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
diskId | string | 是 | 卷设备所属的磁盘设备id |
type | number | 是 | 分区类型 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | 无返回结果的Promise对象 |
错误码:
以下错误码的详细介绍请参见文件管理错误码。
错误码ID | 错误信息 |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | The input parameter is invalid. |
13600001 | IPC error. |
13600008 | No such object. |
13900042 | Unknown error. |
示例:
import { BusinessError } from '@ohos.base';
let diskId: string = "";
let type: number = 0;
volumemanager.partition(diskId, type).then(() => {
console.info("partition successfully");
}).catch((error: BusinessError) => {
console.info("partition failed with error:" + JSON.stringify(error));
});
volumemanager.partition
partition(diskId: string, type: number, callback: AsyncCallback<void>): void
异步对磁盘进行分区,以callback方式返回。当前仅支持将磁盘设备重新分区为一个分区,系统是支持读取多分区的磁盘设备。
需要权限:ohos.permission.MOUNT_FORMAT_MANAGER
系统能力:SystemCapability.FileManagement.StorageService.Volume
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
diskId | string | 是 | 卷设备所属的磁盘id |
type | number | 是 | 分区类型 |
callback | AsyncCallback<void> | 是 | 对磁盘设备进行分区 |
错误码:
以下错误码的详细介绍请参见文件管理错误码。
错误码ID | 错误信息 |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | The input parameter is invalid. |
13600001 | IPC error. |
13600008 | No such object. |
13900042 | Unknown error. |
示例:
import { BusinessError } from '@ohos.base';
let diskId: string = "";
let type: number = 0;
volumemanager.partition(diskId, type, (error: BusinessError) => {
// do something
});
Volume
系统能力:以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.Volume。
属性
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
同上 | 字符串 | 是 | 否 | 卷设备ID的格式为vol-{主设备号}-{次设备号},主设备号用来区分不同种类的设备,次设备号用来区分同一类型的多个设备,卷设备ID会随着插卡顺序不同而变化。 |
uuid | 字符串 | 是 | 否 | 卷设备uuid是卷设备的通用唯一识别码,不会随着插卡顺序变化而变化,但是卷设备的格式化会改变卷设备的uuid。 |
diskId | 字符串 | 是 | 否 | 卷设备所属的磁盘ID,一个磁盘可以有一个或者多个卷设备。磁盘设备ID的格式为disk-{主设备号}-{次设备号},与卷设备ID相似。 |
description | 字符串 | 是 | 否 | 卷设备描述。 |
removable | 布尔 | 是 | 否 | 表示卷设备是否可移除,当前仅支持可移除存储设备。 |
state | 数 | 是 | 否 | 卷设备状态标识: 0:卸载状态 UNMOUNTED 1:检查状态 CHECKING 2:挂载状态 MOUNTED 3:正在弹出状态 EJECTING |
路径 | 字符串 | 是 | 否 | 卷设备的挂载地址,一般为/mnt/data/external/{uuid} |
最后
有很多小伙伴不知道学习哪些鸿蒙开发技术?不知道需要重点掌握哪些鸿蒙应用开发知识点?而且学习时频繁踩坑,最终浪费大量时间。所以有一份实用的鸿蒙(HarmonyOS NEXT)资料用来跟着学习是非常有必要的。
这份鸿蒙(HarmonyOS NEXT)资料包含了鸿蒙开发必掌握的核心知识要点,内容包含了(ArkTS、ArkUI开发组件、Stage模型、多端部署、分布式应用开发、音频、视频、WebGL、OpenHarmony多媒体技术、Napi组件、OpenHarmony内核、Harmony南向开发、鸿蒙项目实战等等)鸿蒙(HarmonyOS NEXT)技术知识点。
希望这一份鸿蒙学习资料能够给大家带来帮助,有需要的小伙伴自行领取,限时开源,先到先得~无套路领取!!
获取这份完整版高清学习路线,请点击→纯血版全套鸿蒙HarmonyOS学习资料
鸿蒙(HarmonyOS NEXT)最新学习路线
-
HarmonOS基础技能
- HarmonOS就业必备技能
- HarmonOS多媒体技术
- 鸿蒙NaPi组件进阶
- HarmonOS高级技能
- 初识HarmonOS内核
- 实战就业级设备开发
有了路线图,怎么能没有学习资料呢,小编也准备了一份联合鸿蒙官方发布笔记整理收纳的一套系统性的鸿蒙(OpenHarmony )学习手册(共计1236页)与鸿蒙(OpenHarmony )开发入门教学视频,内容包含:ArkTS、ArkUI、Web开发、应用模型、资源分类…等知识点。
获取以上完整版高清学习路线,请点击→纯血版全套鸿蒙HarmonyOS学习资料
《鸿蒙 (OpenHarmony)开发入门教学视频》
《鸿蒙生态应用开发V2.0白皮书》
《鸿蒙 (OpenHarmony)开发基础到实战手册》
OpenHarmony北向、南向开发环境搭建
《鸿蒙开发基础》
- ArkTS语言
- 安装DevEco Studio
- 运用你的第一个ArkTS应用
- ArkUI声明式UI开发
- .……
《鸿蒙开发进阶》
- Stage模型入门
- 网络管理
- 数据管理
- 电话服务
- 分布式应用开发
- 通知与窗口管理
- 多媒体技术
- 安全技能
- 任务管理
- WebGL
- 国际化开发
- 应用测试
- DFX面向未来设计
- 鸿蒙系统移植和裁剪定制
- ……
《鸿蒙进阶实战》
- ArkTS实践
- UIAbility应用
- 网络案例
- ……
获取以上完整鸿蒙HarmonyOS学习资料,请点击→纯血版全套鸿蒙HarmonyOS学习资料
总结
总的来说,华为鸿蒙不再兼容安卓,对中年程序员来说是一个挑战,也是一个机会。只有积极应对变化,不断学习和提升自己,他们才能在这个变革的时代中立于不败之地。