文件系统空间统计

2024-01-23 16:33 更新

该模块提供文件系统相关存储信息的功能,向应用程序提供获取文件系统总字节数、空闲字节数的JS接口。

说明

本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

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

statvfs.getFreeSize

getFreeSize(path:string):Promise<number>

异步方法获取指定文件系统空闲字节数,以Promise形式返回结果。

系统能力:SystemCapability.FileManagement.File.FileIO

参数:

参数名

类型

必填

说明

path

string

需要查询的文件系统的文件路径

返回值:

类型

说明

Promise<number>

返回空闲字节数

错误码:

接口抛出错误码的详细介绍请参见基础文件IO错误码

示例:

  1. let path = "/dev";
  2. statvfs.getFreeSize(path).then((number) => {
  3. console.info("getFreeSize promise successfully, Size: " + number);
  4. }).catch((err) => {
  5. console.error("getFreeSize failed with error message: " + err.message + ", error code: " + err.code);
  6. });

statvfs.getFreeSize

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

异步方法获取指定文件系统空闲字节数,使用callback形式返回结果。

系统能力:SystemCapability.FileManagement.File.FileIO

参数:

参数名

类型

必填

说明

path

string

需要查询的文件系统的文件路径

callback

AsyncCallback<number>

异步获取空闲字节数之后的回调

错误码:

接口抛出错误码的详细介绍请参见基础文件IO错误码

示例:

  1. let path = "/dev";
  2. statvfs.getFreeSize(path, (err, number) => {
  3. if (err) {
  4. console.error("getFreeSize failed with error message: " + err.message + ", error code: " + err.code);
  5. } else {
  6. console.info("getFreeSize callback successfully, Size: " + number);
  7. }
  8. });

statvfs.getTotalSize

getTotalSize(path: string): Promise<number>

异步方法获取指定文件系统总字节数,以Promise形式返回结果。

系统能力:SystemCapability.FileManagement.File.FileIO

参数:

参数名

类型

必填

说明

path

string

需要查询的文件系统的文件路径

返回值:

类型

说明

Promise<number>

返回总字节数

错误码:

接口抛出错误码的详细介绍请参见基础文件IO错误码

示例:

  1. let path = "/dev";
  2. statvfs.getTotalSize(path).then((number) => {
  3. console.info("getTotalSize promise successfully, Size: " + number);
  4. }).catch((err) => {
  5. console.error("getTotalSize with error message: " + err.message + ", error code: " + err.code);
  6. });

statvfs.getTotalSize

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

异步方法获取指定文件系统总字节数,使用callback形式返回结果。

系统能力:SystemCapability.FileManagement.File.FileIO

参数:

参数名

类型

必填

说明

path

string

需要查询的文件系统的文件路径

callback

AsyncCallback<number>

异步获取总字节数之后的回调

错误码:

接口抛出错误码的详细介绍请参见基础文件IO错误码

示例:

  1. let path = "/dev";
  2. statvfs.getTotalSize(path, (err, number) => {
  3. if (err) {
  4. console.error("getTotalSize with error message: " + err.message + ", error code: " + err.code);
  5. } else {
  6. console.info("getTotalSize promise successfully, Size: " + number);
  7. }
  8. });
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号