1# @ohos.file.environment (目录环境能力)
2
3该模块提供环境目录能力，获取内存存储根目录、公共文件根目录的JS接口。
4
5> **说明：**
6>
7> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8
9## 导入模块
10
11```ts
12import { Environment } from '@kit.CoreFileKit';
13```
14
15## Environment.getUserDownloadDir<sup>11+</sup>
16
17getUserDownloadDir(): string
18
19获取当前用户预授权下载目录的沙箱路径。当前仅支持2in1设备使用。
20
21**系统能力**：SystemCapability.FileManagement.File.Environment.FolderObtain
22
23**返回值：**
24
25| 类型                  | 说明                  |
26| --------------------- |---------------------|
27| string | 返回当前用户预授权下载目录的沙箱路径。 |
28
29**错误码：**
30
31以下错误码的详细介绍请参见[文件管理子系统错误码](errorcode-filemanagement.md)。
32
33| 错误码ID    | 错误信息       |
34|----------| --------- |
35| 801      | Capability not supported. |
36| 13900042 | Unknown error |
37
38**示例：**
39
40```ts
41import { BusinessError } from '@kit.BasicServicesKit';
42function getUserDownloadDirExample() {
43  try {
44    let path = Environment.getUserDownloadDir();
45    console.log(`success to getUserDownloadDir: ${JSON.stringify(path)}`);
46  } catch (error) {
47    console.error(`failed to getUserDownloadDir because: ${JSON.stringify(error)}`);
48  }
49}
50```
51
52## Environment.getUserDesktopDir<sup>11+</sup>
53
54getUserDesktopDir(): string
55
56获取当前用户预授权桌面目录的沙箱路径。当前仅支持2in1设备使用。
57
58**系统能力**：SystemCapability.FileManagement.File.Environment.FolderObtain
59
60**返回值：**
61
62| 类型                  | 说明                  |
63| --------------------- |---------------------|
64| string | 返回当前用户预授权桌面目录的沙箱路径。 |
65
66**错误码：**
67
68以下错误码的详细介绍请参见[文件管理子系统错误码](errorcode-filemanagement.md)。
69
70| 错误码ID    | 错误信息       |
71|----------| --------- |
72| 801      | Capability not supported. |
73| 13900042 | Unknown error |
74
75**示例：**
76
77```ts
78import { BusinessError } from '@kit.BasicServicesKit';
79function getUserDesktopDirExample() {
80  try {
81    let path = Environment.getUserDesktopDir();
82    console.log(`success to getUserDesktopDir: ${JSON.stringify(path)}`);
83  } catch (error) {
84    console.error(`failed to getUserDesktopDir because: ${JSON.stringify(error)}`);
85  }
86}
87```
88
89## Environment.getUserDocumentDir<sup>11+</sup>
90
91getUserDocumentDir(): string
92
93获取当前用户预授权文档目录的沙箱路径。当前仅支持2in1设备使用。
94
95**系统能力**：SystemCapability.FileManagement.File.Environment.FolderObtain
96
97**返回值：**
98
99| 类型                  | 说明                  |
100| --------------------- |---------------------|
101| string | 返回当前用户预授权文档目录的沙箱路径。 |
102
103**错误码：**
104
105以下错误码的详细介绍请参见[文件管理子系统错误码](errorcode-filemanagement.md)。
106
107| 错误码ID    | 错误信息       |
108|----------| --------- |
109| 801      | Capability not supported. |
110| 13900042 | Unknown error |
111
112**示例：**
113
114```ts
115import { BusinessError } from '@kit.BasicServicesKit';
116function getUserDocumentDirExample() {
117  try {
118    let path = Environment.getUserDocumentDir();
119    console.log(`success to getUserDocumentDir: ${JSON.stringify(path)}`);
120  } catch (error) {
121    console.error(`failed to getUserDocumentDir because: ${JSON.stringify(error)}`);
122  }
123}
124```
125