harmony 鸿蒙@ohos.file.volumeManager (卷管理)

2023-06-24 浏览 (711)

@ohos.file.volumeManager (卷管理)

该模块提供卷设备、磁盘设备查询和管理的相关功能：包括查询卷设备信息，对卷设备的挂载卸载、对磁盘设备分区以及卷设备的格式化等功能。

说明：

  • 本模块首批接口从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错误信息
201Permission verification failed.
202The caller is not a system application.
401The input parameter is invalid.
13600001IPC error.
13900042Unknown error.

示例：

import { BusinessError } from '@ohos.base';
volumemanager.getAllVolumes().then((volumes: volumemanager.Volume) => {
  // do something
}).catch((error: BusinessError) => {
  console.info("getAllVolumes failed");
});

volumemanager.getAllVolumes

getAllVolumes(callback: AsyncCallback<Array<Volume>>): void

异步获取当前外置存储中所有卷设备信息，以callback方式返回。

需要权限：ohos.permission.STORAGE_MANAGER

系统能力：SystemCapability.FileManagement.StorageService.Volume

参数：

参数名类型必填说明
callbackAsyncCallback<Volume[]>是获取当前所有可获得的卷设备信息之后的回调

错误码：

以下错误码的详细介绍请参见文件管理错误码。

错误码ID错误信息
201Permission verification failed.
202The caller is not a system application.
401The input parameter is invalid.
13600001IPC error.
13900042Unknown error.

示例：

import { BusinessError } from '@ohos.base';
volumemanager.getAllVolumes((error: BusinessError, volumes: volumemanager.Volume) => {
  // do something
});

volumemanager.mount

mount(volumeId: string): Promise<void>

异步挂载指定卷设备，以promise方式返回。当前仅支持vfat、exfat以及ntfs三种文件系统的卷设备挂载。

需要权限：ohos.permission.MOUNT_UNMOUNT_MANAGER

系统能力：SystemCapability.FileManagement.StorageService.Volume

参数：

参数名类型必填说明
volumeIdstring是卷设备id

返回值：

类型说明
Promise<void>无返回结果的Promise对象

错误码：

以下错误码的详细介绍请参见文件管理错误码。

错误码ID错误信息
201Permission verification failed.
202The caller is not a system application.
401The input parameter is invalid.
13600001IPC error.
13600002Not supported filesystem.
13600003Failed to mount.
13600005Incorrect volume state.
13600008No such object.
13900042Unknown 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

参数：

参数名类型必填说明
volumeIdstring是卷设备id
callbackAsyncCallback<void>是挂载指定卷设备之后的回调

错误码：

以下错误码的详细介绍请参见文件管理错误码。

错误码ID错误信息
201Permission verification failed.
202The caller is not a system application.
401The input parameter is invalid.
13600001IPC error.
13600002Not supported filesystem.
13600003Failed to mount.
13600005Incorrect volume state.
13600008No such object.
13900042Unknown 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

参数：

参数名类型必填说明
volumeIdstring是卷设备id

返回值：

类型说明
Promise<void>无返回结果的Promise对象

错误码：

以下错误码的详细介绍请参见文件管理错误码。

错误码ID错误信息
201Permission verification failed.
202The caller is not a system application.
401The input parameter is invalid.
13600001IPC error.
13600002Not supported filesystem.
13600004Failed to unmount.
13600005Incorrect volume state.
13600008No such object.
13900042Unknown 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

参数：

参数名类型必填说明
volumeIdstring是卷设备id
callbackAsyncCallback<void>是卸载指定卷设备之后的回调

错误码：

以下错误码的详细介绍请参见文件管理错误码。

错误码ID错误信息
201Permission verification failed.
202The caller is not a system application.
401The input parameter is invalid.
13600001IPC error.
13600002Not supported filesystem.
13600004Failed to unmount.
13600005Incorrect volume state.
13600008No such object.
13900042Unknown 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

参数：

参数名类型必填说明
uuidstring是卷设备uuid

返回值：

类型说明
Promise<Volume>Promise对象，返回当前所有可获得的卷设备信息

错误码：

以下错误码的详细介绍请参见文件管理错误码。

错误码ID错误信息
201Permission verification failed.
202The caller is not a system application.
401The input parameter is invalid.
13600001IPC error.
13600008No such object.
13900042Unknown 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

参数：

参数名类型必填说明
uuidstring是卷设备uuid
callbackAsyncCallback<Volume>是获取卷设备信息之后的回调

错误码：

以下错误码的详细介绍请参见文件管理错误码。

错误码ID错误信息
201Permission verification failed.
202The caller is not a system application.
401The input parameter is invalid.
13600001IPC error.
13600008No such object.
13900042Unknown 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

参数：

参数名类型必填说明
volumeIdstring是卷设备id

返回值：

类型说明
Promise<Volume>Promise对象，返回当前所有可获得的卷设备信息

错误码：

以下错误码的详细介绍请参见文件管理错误码。

错误码ID错误信息
201Permission verification failed.
202The caller is not a system application.
401The input parameter is invalid.
13600001IPC error.
13600008No such object.
13900042Unknown 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

参数：

参数名类型必填说明
volumeIdstring是卷设备id
callbackAsyncCallback<Volume>是获取卷设备信息之后的回调

错误码：

以下错误码的详细介绍请参见文件管理错误码。

错误码ID错误信息
201Permission verification failed.
202The caller is not a system application.
401The input parameter is invalid.
13600001IPC error.
13600008No such object.
13900042Unknown 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

参数：

参数名类型必填说明
uuidstring是卷设备uuid
descriptionstring是卷设备描述

返回值：

类型说明
Promise<void>无返回结果的Promise对象

错误码：

以下错误码的详细介绍请参见文件管理错误码。

错误码ID错误信息
201Permission verification failed.
202The caller is not a system application.
401The input parameter is invalid.
13600001IPC error.
13600002Not supported filesystem.
13600005Incorrect volume state.
13600008No such object.
13900042Unknown 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

参数：

参数名类型必填说明
uuidstring是卷设备uuid
descriptionstring是卷设备描述
callbackAsyncCallback<void>是设置卷描述之后的回调

错误码：

以下错误码的详细介绍请参见文件管理错误码。

错误码ID错误信息
201Permission verification failed.
202The caller is not a system application.
401The input parameter is invalid.
13600001IPC error.
13600002Not supported filesystem.
13600005Incorrect volume state.
13600008No such object.
13900042Unknown 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

参数：

参数名类型必填说明
volumeIdstring是卷设备id
fsTypestring是文件系统类型（vfat或者exfat）

返回值：

类型说明
Promise<void>无返回结果的Promise对象

错误码：

以下错误码的详细介绍请参见文件管理错误码。

错误码ID错误信息
201Permission verification failed.
202The caller is not a system application.
401The input parameter is invalid.
13600001IPC error.
13600002Not supported filesystem.
13600005Incorrect volume state.
13600008No such object.
13900042Unknown 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

参数：

参数名类型必填说明
volumeIdstring是卷设备id
fsTypestring是文件系统类型(vfat或者exfat)
callbackAsyncCallback<void>是对指定卷设备格式化后的回调

错误码：

以下错误码的详细介绍请参见文件管理错误码。

错误码ID错误信息
201Permission verification failed.
202The caller is not a system application.
401The input parameter is invalid.
13600001IPC error.
13600002Not supported filesystem.
13600005Incorrect volume state.
13600008No such object.
13900042Unknown 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

参数：

参数名类型必填说明
diskIdstring是卷设备所属的磁盘设备id
typenumber是分区类型

返回值：

类型说明
Promise<void>无返回结果的Promise对象

错误码：

以下错误码的详细介绍请参见文件管理错误码。

错误码ID错误信息
201Permission verification failed.
202The caller is not a system application.
401The input parameter is invalid.
13600001IPC error.
13600008No such object.
13900042Unknown 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

参数：

参数名类型必填说明
diskIdstring是卷设备所属的磁盘id
typenumber是分区类型
callbackAsyncCallback<void>是对磁盘设备进行分区

错误码：

以下错误码的详细介绍请参见文件管理错误码。

错误码ID错误信息
201Permission verification failed.
202The caller is not a system application.
401The input parameter is invalid.
13600001IPC error.
13600008No such object.
13900042Unknown 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。

属性

名称类型可读可写说明
idstring是否卷设备ID的格式为vol-{主设备号}-{次设备号}，主设备号用来区分不同种类的设备，次设备号用来区分同一类型的多个设备，卷设备ID会随着插卡顺序不同而变化。
uuidstring是否卷设备uuid是卷设备的通用唯一识别码，不会随着插卡顺序变化而变化，但是卷设备的格式化会改变卷设备的uuid。
diskIdstring是否卷设备所属的磁盘ID，一个磁盘可以有一个或者多个卷设备。磁盘设备ID的格式为disk-{主设备号}-{次设备号}，与卷设备ID相似。
descriptionstring是否卷设备描述。
removableboolean是否表示卷设备是否可移除，当前仅支持可移除存储设备。
statenumber是否卷设备状态标识：
0：卸载状态 UNMOUNTED
1：检查状态 CHECKING
2：挂载状态 MOUNTED
3：正在弹出状态 EJECTING
pathstring是否卷设备的挂载地址，一般为/mnt/data/external/{uuid}

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述（仅对系统应用开放）

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

  • 所属分类： 后端技术
  • 本文标签： 软件 鸿蒙
  • 版权声明： 本文链接 https://seaxiang.com/blog/ced288d7d2b247cc9ba735a21dc26c3c