• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 目录环境能力
2
3该模块提供环境目录能力，获取内存存储根目录、公共文件根目录的JS接口。
4
5> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
6>
7> - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8> - 本模块接口为系统接口，三方应用不支持调用。
9
10## 导入模块
11
12```js
13import environment from '@ohos.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(function(path){
34      console.info("getStorageDataDir successfully:"+ path);
35  }).catch(function(error){
36      console.info("getStorageDataDir failed with error:"+ error);
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(function(error, path){
58      // do something
59  });
60  ```
61
62## environment.getUserDataDir
63
64getUserDataDir():Promise<string>
65
66异步方法获取公共文件根目录，以promise形式返回结果。
67
68**系统能力**：SystemCapability.FileManagement.File.Environment
69
70- 返回值：
71
72  | 类型                  | 说明               |
73  | --------------------- | ------------------ |
74  | Promise<string> | 返回公共文件根目录 |
75
76- 示例：
77
78  ```js
79  environment.getUserDataDir().then(function(path){
80      console.info("getUserDataDir successfully:"+ path);
81  }).catch(function(error){
82      console.info("getUserDataDir failed with error:"+ error);
83  });
84  ```
85
86## environment.getUserDataDir
87
88getUserDataDir(callback:AsyncCallback<string>): void
89
90异步方法获取公共文件根目录，以callback形式返回结果。
91
92**系统能力**：SystemCapability.FileManagement.File.Environment
93
94- 参数：
95
96  | 参数名   | 类型                        | 必填 | 说明                             |
97  | -------- | --------------------------- | ---- | -------------------------------- |
98  | callback | AsyncCallback<string> | 是   | 异步获取公共文件根目录之后的回调 |
99
100- 示例：
101
102  ```js
103  environment.getUserDataDir(function(error, path){
104      // do something
105  });
106  ```
107
108