1# oh_environment.h 2 3## 概述 4 5environment模块接口定义，使用environment提供的native接口，获取公共文件根目录的沙箱路径。 6 7**引用文件：** <filemanagement/environment/oh_environment.h> 8 9**库：** libohenvironment.so 10 11**系统能力：** SystemCapability.FileManagement.File.Environment.FolderObtain 12 13**起始版本：** 12 14 15**相关模块：** [Environment](capi-environment.md) 16 17## 汇总 18 19### 函数 20 21| 名称 | 描述 | 22| -- | -- | 23| [FileManagement_ErrCode OH_Environment_GetUserDownloadDir(char **result)](#oh_environment_getuserdownloaddir) | 获取Download根目录沙箱路径。 | 24| [FileManagement_ErrCode OH_Environment_GetUserDesktopDir(char **result)](#oh_environment_getuserdesktopdir) | 获取Desktop根目录沙箱路径。 | 25| [FileManagement_ErrCode OH_Environment_GetUserDocumentDir(char **result)](#oh_environment_getuserdocumentdir) | 获取Document根目录沙箱路径。 | 26 27## 函数说明 28 29### OH_Environment_GetUserDownloadDir() 30 31``` 32FileManagement_ErrCode OH_Environment_GetUserDownloadDir(char **result) 33``` 34 35**描述** 36 37获取Download根目录沙箱路径。 38 39**需要权限：** ohos.permission.READ_WRITE_DOWNLOAD_DIRECTORY。 40 41**起始版本：** 12 42 43 44**参数：** 45 46| 参数项 | 描述 | 47| -- | -- | 48| char **result | Download根目录路径指针。请引用头文件malloc.h并使用free()进行资源释放。 | 49 50**返回：** 51 52| 类型 | 说明 | 53| -- | -- | 54| [FileManagement_ErrCode](capi-error-code-h.md#filemanagement_errcode) | 返回FileManagement模块错误码[FileManagement_ErrCode](capi-error-code-h.md#filemanagement_errcode)。 | 55 56### OH_Environment_GetUserDesktopDir() 57 58``` 59FileManagement_ErrCode OH_Environment_GetUserDesktopDir(char **result) 60``` 61 62**描述** 63 64获取Desktop根目录沙箱路径。 65 66**需要权限：** ohos.permission.READ_WRITE_DESKTOP_DIRECTORY。 67 68**起始版本：** 12 69 70 71**参数：** 72 73| 参数项 | 描述 | 74| -- | -- | 75| char **result | Desktop根目录路径指针。请引用头文件malloc.h并使用free()进行资源释放。 | 76 77**返回：** 78 79| 类型 | 说明 | 80| -- | -- | 81| [FileManagement_ErrCode](capi-error-code-h.md#filemanagement_errcode) | 返回FileManagement模块错误码[FileManagement_ErrCode](capi-error-code-h.md#filemanagement_errcode)。 | 82 83### OH_Environment_GetUserDocumentDir() 84 85``` 86FileManagement_ErrCode OH_Environment_GetUserDocumentDir(char **result) 87``` 88 89**描述** 90 91获取Document根目录沙箱路径。 92 93**需要权限：** ohos.permission.READ_WRITE_DOCUMENTS_DIRECTORY 94 95**起始版本：** 12 96 97 98**参数：** 99 100| 参数项 | 描述 | 101| -- | -- | 102| char **result | Document根目录路径指针。请引用头文件malloc.h并使用free()进行资源释放。 | 103 104**返回：** 105 106| 类型 | 说明 | 107| -- | -- | 108| [FileManagement_ErrCode](capi-error-code-h.md#filemanagement_errcode) | 返回FileManagement模块错误码[FileManagement_ErrCode](capi-error-code-h.md#filemanagement_errcode)。 | 109 110 111