@ohos.file.statvfs (File System Space Statistics)

The statfs module provides APIs for obtaining file system information, including the total size and free size a file system, in bytes.

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.

Modules to Import

import statvfs from '@ohos.file.statvfs';

statvfs.getFreeSize

getFreeSize(path:string):Promise<number>

Obtains the free size of the specified file system in bytes. This API uses a promise to return the result.

System capability: SystemCapability.FileManagement.File.FileIO

Parameters

Return value

Error codes

For details about the error codes, see Basic File IO Error Codes.

Example

import { BusinessError } from '@ohos.base';
import common from '@ohos.app.ability.common';

let context = getContext(this) as common.UIAbilityContext;
let path = context.filesDir;
statvfs.getFreeSize(path).then((number: number) => {
  console.info("getFreeSize succeed, Size: " + number);
}).catch((err: BusinessError) => {
  console.error("getFreeSize failed with error message: " + err.message + ", error code: " + err.code);
});

statvfs.getFreeSize

getFreeSize(path:string, callback:AsyncCallback<number>): void

Obtains the free size of the specified file system in bytes. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.FileManagement.File.FileIO

Parameters

Error codes

For details about the error codes, see Basic File IO Error Codes.

Example

import { BusinessError } from '@ohos.base';
import common from '@ohos.app.ability.common';

let context = getContext(this) as common.UIAbilityContext;
let path = context.filesDir;
statvfs.getFreeSize(path, (err: BusinessError, number: number) => {
  if (err) {
    console.error("getFreeSize failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("getFreeSize succeed, Size: " + number);
  }
});

statvfs.getFreeSizeSync¹⁰⁺

getFreeSizeSync(path:string): number

Obtains the free size of the specified file system in bytes. This API returns the result synchronously.

System capability: SystemCapability.FileManagement.File.FileIO

Parameters

Return value

Error codes

For details about the error codes, see Basic File IO Error Codes.

Example

import common from '@ohos.app.ability.common';

let context = getContext(this) as common.UIAbilityContext;
let path = context.filesDir;
let number = statvfs.getFreeSizeSync(path);
console.info("getFreeSizeSync succeed, Size: " + number);

statvfs.getTotalSize

getTotalSize(path: string): Promise<number>

Obtains the total size of the specified file system in bytes. This API uses a promise to return the result.

System capability: SystemCapability.FileManagement.File.FileIO

Parameters

Return value

Error codes

For details about the error codes, see Basic File IO Error Codes.

Example

import { BusinessError } from '@ohos.base';
import common from '@ohos.app.ability.common';

let context = getContext(this) as common.UIAbilityContext;
let path = context.filesDir;
statvfs.getTotalSize(path).then((number: number) => {
  console.info("getTotalSize succeed, Size: " + number);
}).catch((err: BusinessError) => {
  console.error("getTotalSize failed with error message: " + err.message + ", error code: " + err.code);
});

statvfs.getTotalSize

getTotalSize(path: string, callback: AsyncCallback<number>): void

Obtains the total size of the specified file system in bytes. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.FileManagement.File.FileIO

Parameters

Error codes

For details about the error codes, see Basic File IO Error Codes.

Example

import { BusinessError } from '@ohos.base';
import common from '@ohos.app.ability.common';

let context = getContext(this) as common.UIAbilityContext;
let path = context.filesDir;
statvfs.getTotalSize(path, (err: BusinessError, number: number) => {
  if (err) {
    console.info("getTotalSize failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("getTotalSize succeed, Size: " + number);
  }
});

statvfs.getTotalSizeSync¹⁰⁺

getTotalSizeSync(path: string): number

Obtains the total size of the specified file system in bytes. This API returns the result synchronously.

System capability: SystemCapability.FileManagement.File.FileIO

Parameters

Return value

Error codes

For details about the error codes, see Basic File IO Error Codes.

Example

import common from '@ohos.app.ability.common';

let context = getContext(this) as common.UIAbilityContext;
let path = context.filesDir;
let number = statvfs.getTotalSizeSync(path);
console.info("getTotalSizeSync succeed, Size: " + number);