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