harmony 鸿蒙@ohos.file.environment (目录环境能力)

2025-06-12
浏览 (3)

@ohos.file.environment (目录环境能力)

该模块提供环境目录能力，获取内存存储根目录、公共文件根目录的JS接口。

说明：

本模块首批接口从API version 11开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import { Environment } from '@kit.CoreFileKit';

Environment.getUserDownloadDir

getUserDownloadDir(): string

获取当前用户预授权下载目录的沙箱路径。当前仅支持2in1设备使用。

系统能力：SystemCapability.FileManagement.File.Environment.FolderObtain

返回值：

类型	说明
string	返回当前用户预授权下载目录的沙箱路径。

错误码：

以下错误码的详细介绍请参见文件管理子系统错误码。

错误码ID	错误信息
801	Capability not supported.
13900042	Unknown error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';
function getUserDownloadDirExample() {
  try {
    let path = Environment.getUserDownloadDir();
    console.log(`success to getUserDownloadDir: ${JSON.stringify(path)}`);
  } catch (error) {
    console.error(`failed to getUserDownloadDir, Error code: ${error.code}, message: ${error.message}`);
  }
}

Environment.getUserDesktopDir

getUserDesktopDir(): string

获取当前用户预授权桌面目录的沙箱路径。当前仅支持2in1设备使用。

系统能力：SystemCapability.FileManagement.File.Environment.FolderObtain

返回值：

类型	说明
string	返回当前用户预授权桌面目录的沙箱路径。

错误码：

以下错误码的详细介绍请参见文件管理子系统错误码。

错误码ID	错误信息
801	Capability not supported.
13900042	Unknown error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';
function getUserDesktopDirExample() {
  try {
    let path = Environment.getUserDesktopDir();
    console.log(`success to getUserDesktopDir: ${JSON.stringify(path)}`);
  } catch (error) {
    console.error(`failed to getUserDesktopDir, Error code: ${error.code}, message: ${error.message}`);
  }
}

Environment.getUserDocumentDir

getUserDocumentDir(): string

获取当前用户预授权文档目录的沙箱路径。当前仅支持2in1设备使用。

系统能力：SystemCapability.FileManagement.File.Environment.FolderObtain

返回值：

类型	说明
string	返回当前用户预授权文档目录的沙箱路径。

错误码：

以下错误码的详细介绍请参见文件管理子系统错误码。

错误码ID	错误信息
801	Capability not supported.
13900042	Unknown error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';
function getUserDocumentDirExample() {
  try {
    let path = Environment.getUserDocumentDir();
    console.log(`success to getUserDocumentDir: ${JSON.stringify(path)}`);
  } catch (error) {
    console.error(`failed to getUserDocumentDir, Error code: ${error.code}, message: ${error.message}`);
  }
}