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