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