• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.file.statvfs (文件系统空间统计)
2
3该模块提供文件系统相关存储信息的功能，向应用程序提供获取文件系统总字节数、空闲字节数的JS接口。
4
5> **说明：**
6> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
7> 本模块支持对错误码进行处理，错误码及其适配方式[参考文档](../errorcodes/errorcode-filemanagement.md#错误码适配指导)。
8
9## 导入模块
10
11```js
12import statvfs from '@ohos.file.statvfs';
13```
14## statvfs.getFreeSize
15
16getFreeSize(path:string):Promise<number>
17
18异步方法获取指定文件系统空闲字节数，以Promise形式返回结果。
19
20**系统能力**：SystemCapability.FileManagement.File.FileIO
21
22**参数：**
23
24  | 参数名 | 类型   | 必填 | 说明                         |
25  | ------ | ------ | ---- | ---------------------------- |
26  | path   | string | 是   | 需要查询的文件系统的文件路径 |
27
28**返回值：**
29
30  | 类型                  | 说明           |
31  | --------------------- | -------------- |
32  | Promise<number> | 返回空闲字节数 |
33
34**示例：**
35
36  ```js
37  let path = "/dev";
38  statvfs.getFreeSize(path).then((number) => {
39    console.info("getFreeSize promise successfully, Size: " + number);
40  }).catch((err) => {
41    console.info("getFreeSize failed with error message: " + err.message + ", error code: " + err.code);
42  });
43  ```
44
45## statvfs.getFreeSize
46
47getFreeSize(path:string, callback:AsyncCallback<number>): void
48
49异步方法获取指定文件系统空闲字节数，使用callback形式返回结果。
50
51**系统能力**：SystemCapability.FileManagement.File.FileIO
52
53**参数：**
54
55  | 参数名   | 类型                        | 必填 | 说明                         |
56  | -------- | --------------------------- | ---- | ---------------------------- |
57  | path     | string                      | 是   | 需要查询的文件系统的文件路径 |
58  | callback | AsyncCallback<number> | 是   | 异步获取空闲字节数之后的回调 |
59
60**示例：**
61
62  ```js
63  let path = "/dev";
64  statvfs.getFreeSize(path, (err, number) => {
65    if (err) {
66      console.info("getFreeSize failed with error message: " + err.message + ", error code: " + err.code);
67    } else {
68      console.info("getFreeSize callback successfully, Size: " + number);
69    }
70  });
71  ```
72
73## statvfs.getTotalSize
74
75getTotalSize(path: string): Promise<number>
76
77异步方法获取指定文件系统总字节数，以Promise形式返回结果。
78
79**系统能力**：SystemCapability.FileManagement.File.FileIO
80
81**参数：**
82
83  | 参数名 | 类型   | 必填 | 说明                         |
84  | ---- | ------ | ---- | ---------------------------- |
85  | path | string | 是   | 需要查询的文件系统的文件路径 |
86
87**返回值：**
88
89  | 类型                  | 说明         |
90  | --------------------- | ------------ |
91  | Promise<number> | 返回总字节数 |
92
93**示例：**
94
95  ```js
96  let path = "/dev";
97  statvfs.getTotalSize(path).then((number) => {
98    console.info("getTotalSize promise successfully, Size: " + number);
99  }).catch((err) => {
100    console.info("getTotalSize with error message: " + err.message + ", error code: " + err.code);
101  });
102  ```
103
104## statvfs.getTotalSize
105
106getTotalSize(path: string, callback: AsyncCallback<number>): void
107
108异步方法获取指定文件系统总字节数，使用callback形式返回结果。
109
110**系统能力**：SystemCapability.FileManagement.File.FileIO
111
112**参数：**
113
114  | 参数名   | 类型                        | 必填 | 说明                         |
115  | -------- | --------------------------- | ---- | ---------------------------- |
116  | path     | string                      | 是   | 需要查询的文件系统的文件路径 |
117  | callback | AsyncCallback<number> | 是   | 异步获取总字节数之后的回调   |
118
119**示例：**
120
121  ```js
122  let path = "/dev";
123  statvfs.getTotalSize(path, (err, number) => {
124    if (err) {
125      console.info("getTotalSize with error message: " + err.message + ", error code: " + err.code);
126    } else {
127      console.info("getTotalSize promise successfully, Size: " + number);
128    }
129  });
130  ```
131
132