harmony 鸿蒙@ohos.file.volumeManager (Volume Management)
@ohos.file.volumeManager (Volume Management)
The volumeManager module provides APIs for volume and disk management, including obtaining volume information, mounting or unmounting a volume, partitioning a disk, and formatting a volume.
NOTE
- The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
- The APIs provided by this module are system APIs.
Modules to Import
import volumemanager from "@ohos.file.volumeManager";
volumemanager.getAllVolumes
getAllVolumes(): Promise<Array<Volume>>
Obtains information about all volumes of this external storage device. This API uses a promise to return the result.
Required permissions: ohos.permission.STORAGE_MANAGER
System capability: SystemCapability.FileManagement.StorageService.Volume
Return value
Type | Description |
---|---|
Promise<Volume[]> | Promise used to return information about all available volumes. |
Error codes
For details about the error codes, see File Management Error Codes.
ID | Error Message |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | The input parameter is invalid. |
13600001 | IPC error. |
13900042 | Unknown error. |
Example
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
Obtains information about all volumes of this external storage device. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.STORAGE_MANAGER
System capability: SystemCapability.FileManagement.StorageService.Volume
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<Volume[]> | Yes | Callback invoked to return information about all available volumes. |
Error codes
For details about the error codes, see File Management Error Codes.
ID | Error Message |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | The input parameter is invalid. |
13600001 | IPC error. |
13900042 | Unknown error. |
Example
import { BusinessError } from '@ohos.base';
volumemanager.getAllVolumes((error: BusinessError, volumes: volumemanager.Volume) => {
// Do something.
});
volumemanager.mount
mount(volumeId: string): Promise<void>
Asynchronously mounts a volume. This API uses a promise to return the result. Currently, only the File Allocation Table (FAT), Extensible FAT (exFAT), and New Technology File System (NTFS) file systems are supported.
Required permissions: ohos.permission.MOUNT_UNMOUNT_MANAGER
System capability: SystemCapability.FileManagement.StorageService.Volume
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
volumeId | string | Yes | Volume ID. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see File Management Error Codes.
ID | Error Message |
---|---|
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. |
Example
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
Asynchronously mounts a volume. This API uses an asynchronous callback to return the result. Currently, only the FAT, exFAT, and NTFS file systems are supported.
Required permissions: ohos.permission.MOUNT_UNMOUNT_MANAGER
System capability: SystemCapability.FileManagement.StorageService.Volume
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
volumeId | string | Yes | Volume ID. |
callback | AsyncCallback<void> | Yes | Callback that returns no value. |
Error codes
For details about the error codes, see File Management Error Codes.
ID | Error Message |
---|---|
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. |
Example
import { BusinessError } from '@ohos.base';
let volumeId: string = "";
volumemanager.mount(volumeId, (error: BusinessError) => {
// Do something.
});
volumemanager.unmount
unmount(volumeId: string): Promise<void>
Asynchronously unmounts a volume. This API uses a promise to return the result.
Required permissions: ohos.permission.MOUNT_UNMOUNT_MANAGER
System capability: SystemCapability.FileManagement.StorageService.Volume
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
volumeId | string | Yes | Volume ID. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see File Management Error Codes.
ID | Error Message |
---|---|
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. |
Example
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
Asynchronously unmounts a volume. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.MOUNT_UNMOUNT_MANAGER
System capability: SystemCapability.FileManagement.StorageService.Volume
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
volumeId | string | Yes | Volume ID. |
callback | AsyncCallback<void> | Yes | Callback that returns no value. |
Error codes
For details about the error codes, see File Management Error Codes.
ID | Error Message |
---|---|
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. |
Example
import { BusinessError } from '@ohos.base';
let volumeId: string = "";
volumemanager.unmount(volumeId, (error: BusinessError) => {
// Do something.
});
volumemanager.getVolumeByUuid
getVolumeByUuid(uuid: string): Promise<Volume>
Obtains information about a volume based on the universally unique identifier (UUID). This API uses a promise to return the result.
Required permissions: ohos.permission.STORAGE_MANAGER
System capability: SystemCapability.FileManagement.StorageService.Volume
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
uuid | string | Yes | UUID of the volume. |
Return value
Type | Description |
---|---|
Promise<Volume> | Promise used to return the volume information obtained. |
Error codes
For details about the error codes, see File Management Error Codes.
ID | Error Message |
---|---|
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. |
Example
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
Obtains information about a volume based on the UUID. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.STORAGE_MANAGER
System capability: SystemCapability.FileManagement.StorageService.Volume
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
uuid | string | Yes | UUID of the volume. |
callback | AsyncCallback<Volume> | Yes | Callback invoked to return the volume information obtained. |
Error codes
For details about the error codes, see File Management Error Codes.
ID | Error Message |
---|---|
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. |
Example
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>
Obtains information about a volume based on the volume ID. This API uses a promise to return the result.
Required permissions: ohos.permission.STORAGE_MANAGER
System capability: SystemCapability.FileManagement.StorageService.Volume
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
volumeId | string | Yes | Volume ID. |
Return value
Type | Description |
---|---|
Promise<Volume> | Promise used to return the volume information obtained. |
Error codes
For details about the error codes, see File Management Error Codes.
ID | Error Message |
---|---|
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. |
Example
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
Obtains information about a volume based on the volume ID. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.STORAGE_MANAGER
System capability: SystemCapability.FileManagement.StorageService.Volume
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
volumeId | string | Yes | Volume ID. |
callback | AsyncCallback<Volume> | Yes | Callback invoked to return the volume information obtained. |
Error codes
For details about the error codes, see File Management Error Codes.
ID | Error Message |
---|---|
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. |
Example
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>
Sets volume description. This API uses a promise to return the result.
Required permissions: ohos.permission.MOUNT_UNMOUNT_MANAGER
System capability: SystemCapability.FileManagement.StorageService.Volume
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
uuid | string | Yes | UUID of the volume. |
description | string | Yes | Volume description to set. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see File Management Error Codes.
ID | Error Message |
---|---|
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. |
Example
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
Sets volume description. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.MOUNT_UNMOUNT_MANAGER
System capability: SystemCapability.FileManagement.StorageService.Volume
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
uuid | string | Yes | UUID of the volume. |
description | string | Yes | Volume description to set. |
callback | AsyncCallback<void> | Yes | Callback that returns no value. |
Error codes
For details about the error codes, see File Management Error Codes.
ID | Error Message |
---|---|
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. |
Example
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>
Formats a volume. This API uses a promise to return the result. Currently, only the virtual file allocation table (VFAT) and exFAT file systems are supported. Only unmounted volumes can be formatted. After a volume is formatted, the UUID, mounting path, and description of the volume change.
Required permissions: ohos.permission.MOUNT_FORMAT_MANAGER
System capability: SystemCapability.FileManagement.StorageService.Volume
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
volumeId | string | Yes | Volume ID. |
fsType | string | Yes | File system type, which can be VFAT or exFAT. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see File Management Error Codes.
ID | Error Message |
---|---|
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. |
Example
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
Formats a volume. This API uses an asynchronous callback to return the result. Currently, only the VFAT and exFAT file systems are supported. Only unmounted volumes can be formatted. After a volume is formatted, the UUID, mounting path, and description of the volume change.
Required permissions: ohos.permission.MOUNT_FORMAT_MANAGER
System capability: SystemCapability.FileManagement.StorageService.Volume
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
volumeId | string | Yes | Volume ID. |
fsType | string | Yes | File system type, which can be VFAT or exFAT. |
callback | AsyncCallback<void> | Yes | Callback that returns no value. |
Error codes
For details about the error codes, see File Management Error Codes.
ID | Error Message |
---|---|
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. |
Example
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>
Partitions a disk. This API uses a promise to return the result. The system supports access to multi-partition disks. Currently, this API can partition a disk into only one partition.
Required permissions: ohos.permission.MOUNT_FORMAT_MANAGER
System capability: SystemCapability.FileManagement.StorageService.Volume
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
diskId | string | Yes | ID of the disk to partition. |
type | number | Yes | Partition type. |
Return value
|Type |Description | |———————|———————–| |Promise<void> |Promise that returns no value. |
Error codes
For details about the error codes, see File Management Error Codes.
ID | Error Message |
---|---|
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. |
Example
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
Asynchronously partitions a disk. This API uses a callback to return the result. The system supports access to multi-partition disks. Currently, this API can partition a disk into only one partition.
Required permissions: ohos.permission.MOUNT_FORMAT_MANAGER
System capability: SystemCapability.FileManagement.StorageService.Volume
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
diskId | string | Yes | ID of the disk to partition. |
type | number | Yes | Partition type. |
callback | AsyncCallback<void> | Yes | Callback that returns no value. |
Error codes
For details about the error codes, see File Management Error Codes.
ID | Error Message |
---|---|
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. |
Example
import { BusinessError } from '@ohos.base';
let diskId: string = "";
let type: number = 0;
volumemanager.partition(diskId, type, (error: BusinessError) => {
// Do something.
});
Volume
System capability: SystemCapability.FileManagement.StorageService.Volume
Attributes
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
id | string | Yes | No | Volume ID, in the vol-{Primary device ID}-{Secondary device ID} format. The primary device IDs identify devices of different types. The secondary device IDs identify different devices of the same type. The volume IDs vary depending on the card insertion sequence. |
uuid | string | Yes | No | Volume UUID, which uniquely identifies a volume irrespective of the card insertion sequence. However, the UUID of a volume will change after the volume is formatted. |
diskId | string | Yes | No | ID of the disk to which the volume belongs. A disk can have one or more volumes. The disk ID is in the disk-{Primary device ID}-{Secondary device ID} format, which is similar to the volume ID. |
description | string | Yes | No | Description of the volume. |
removable | boolean | Yes | No | Whether the volume can be removed. Currently, only removable storage devices are supported. |
state | number | Yes | No | Volume status. 0: The volume is unmounted. 1: The volume is being checked. 2: The volume is mounted. 3: The volume is being ejected. |
path | string | Yes | No | Path of the volume mounted. Generally, the path is /mnt/data/external/{uuid}. |
你可能感兴趣的鸿蒙文章
harmony 鸿蒙System Common Events (To Be Deprecated Soon)
harmony 鸿蒙System Common Events
harmony 鸿蒙API Reference Document Description
harmony 鸿蒙Enterprise Device Management Overview (for System Applications Only)
harmony 鸿蒙BundleStatusCallback
harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager)
harmony 鸿蒙@ohos.distributedBundle (Distributed Bundle Management)
harmony 鸿蒙@ohos.bundle (Bundle)
harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)
- 所属分类: 后端技术
- 本文标签:
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦