• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.file.environment (目录环境能力)
2
3该模块提供环境目录能力,获取内存存储根目录、公共文件根目录的JS接口。
4
5> **说明:**
6>
7> - 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8> - 本模块接口为系统接口,三方应用不支持调用。
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以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md)。
33| 错误码ID                     | 错误信息        |
34| ---------------------------- | ---------- |
35| 202 | The caller is not a system application |
36| 13900020 | Invalid argument |
37| 13900042 | Unknown error |
38
39**示例:**
40
41  ```js
42  environment.getStorageDataDir().then((path) => {
43      console.info("getStorageDataDir successfully, Path: " + path);
44  }).catch((err) => {
45      console.info("getStorageDataDir failed with error message: " + err.message + ", error code: " + err.code);
46  });
47  ```
48
49## environment.getStorageDataDir
50
51getStorageDataDir(callback:AsyncCallback<string>):void
52
53异步方法获取内存存储根目录,以callback形式返回结果。
54
55**系统能力**:SystemCapability.FileManagement.File.Environment
56
57**参数:**
58
59| 参数名   | 类型                        | 必填 | 说明                             |
60| -------- | --------------------------- | ---- | -------------------------------- |
61| callback | AsyncCallback<string> | 是   | 异步获取内存存储根目录之后的回调 |
62
63**错误码:**
64
65以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md)。
66| 错误码ID                     | 错误信息        |
67| ---------------------------- | ---------- |
68| 202 | The caller is not a system application |
69| 13900020 | Invalid argument |
70| 13900042 | Unknown error |
71
72**示例:**
73
74  ```js
75  environment.getStorageDataDir((err, path) => {
76    if (err) {
77      console.info("getStorageDataDir failed with error message: " + err.message + ", error code: " + err.code);
78    } else {
79      console.info("getStorageDataDir successfully, Path: " + path);
80    }
81  });
82  ```
83
84## environment.getUserDataDir
85
86getUserDataDir():Promise<string>
87
88异步方法获取公共文件根目录,以promise形式返回结果。
89
90**系统能力**:SystemCapability.FileManagement.File.Environment
91
92**返回值:**
93
94| 类型                  | 说明               |
95| --------------------- | ------------------ |
96| Promise<string> | 返回公共文件根目录 |
97
98**错误码:**
99
100以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md)。
101| 错误码ID                     | 错误信息        |
102| ---------------------------- | ---------- |
103| 202 | The caller is not a system application |
104| 13900020 | Invalid argument |
105| 13900042 | Unknown error |
106
107**示例:**
108
109  ```js
110  environment.getUserDataDir().then((path) => {
111    console.info("getUserDataDir successfully, Path: " + path);
112  }).catch((err) => {
113    console.info("getUserDataDir failed with error message: " + err.message + ", error code: " + err.code);
114  });
115  ```
116
117## environment.getUserDataDir
118
119getUserDataDir(callback:AsyncCallback<string>): void
120
121异步方法获取公共文件根目录,以callback形式返回结果。
122
123**系统能力**:SystemCapability.FileManagement.File.Environment
124
125**参数:**
126
127| 参数名   | 类型                        | 必填 | 说明                             |
128| -------- | --------------------------- | ---- | -------------------------------- |
129| callback | AsyncCallback<string> | 是   | 异步获取公共文件根目录之后的回调 |
130
131**错误码:**
132
133以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md)。
134| 错误码ID                     | 错误信息        |
135| ---------------------------- | ---------- |
136| 202 | The caller is not a system application |
137| 13900020 | Invalid argument |
138| 13900042 | Unknown error |
139
140**示例:**
141
142  ```js
143  environment.getUserDataDir((err, path) => {
144    if (err) {
145      console.info("getUserDataDir failed with error message: " + err.message + ", error code: " + err.code);
146    } else {
147      console.info("getUserDataDir successfully, Path: " + path);
148    }
149  });
150  ```
151