@ohos.file.environment (Directory Environment Capability) (System API)

The Environment module provides APIs for obtaining the root directories of the storage and user files.

NOTE

• The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
• This topic describes only the system APIs provided by the module. For details about its public APIs, see @ohos.file.environment.

Modules to Import

import environment from '@ohos.file.environment';

environment.getStorageDataDir

getStorageDataDir():Promise<string>

Obtains the root directory of the memory. This API uses a promise to return the result.

System capability: SystemCapability.FileManagement.File.Environment

System API: This is a system API.

Return value

Error codes

For details about the error codes, see File Management Error Codes.

Example

import { BusinessError } from '@ohos.base';
environment.getStorageDataDir().then((path: string) => {
    console.info("getStorageDataDir successfully, Path: " + path);
}).catch((err: BusinessError) => {
    console.info("getStorageDataDir failed with error message: " + err.message + ", error code: " + err.code);
});

environment.getStorageDataDir

getStorageDataDir(callback:AsyncCallback<string>):void

Obtains the root directory of the memory. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.FileManagement.File.Environment

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see File Management Error Codes.

Example

import { BusinessError } from '@ohos.base';
environment.getStorageDataDir((err: BusinessError, path: string) => {
  if (err) {
    console.info("getStorageDataDir failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("getStorageDataDir successfully, Path: " + path);
  }
});

environment.getUserDataDir

getUserDataDir():Promise<string>

Obtains the root directory of user files. This API uses a promise to return the result.

System capability: SystemCapability.FileManagement.File.Environment

System API: This is a system API.

Return value

Error codes

For details about the error codes, see File Management Error Codes.

Example

import { BusinessError } from '@ohos.base';
environment.getUserDataDir().then((path: string) => {
  console.info("getUserDataDir successfully, Path: " + path);
}).catch((err: BusinessError) => {
  console.info("getUserDataDir failed with error message: " + err.message + ", error code: " + err.code);
});

environment.getUserDataDir

getUserDataDir(callback:AsyncCallback<string>): void

Obtains the root directory of user files. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.FileManagement.File.Environment

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see File Management Error Codes.

Example

import { BusinessError } from '@ohos.base';
environment.getUserDataDir((err: BusinessError, path: string) => {
  if (err) {
    console.info("getUserDataDir failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("getUserDataDir successfully, Path: " + path);
  }
});

environment.getExternalStorageDir¹¹⁺

getExternalStorageDir(): string

Obtains the sandbox path of the root directory of the external storage card. This API is available only to certain devices.

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

System capability: SystemCapability.FileManagement.File.Environment.FolderObtain

System API: This is a system API.

Return value

Error codes

For details about the error codes, see File Management Error Codes.

Example

import { BusinessError } from '@ohos.base';
function getExternalStorageDirExample() {
  try {
    let path = environment.getExternalStorageDir();
    console.log(`success to getExternalStorageDir: ${JSON.stringify(path)}`);
  } catch (error) {
    console.error(`failed to getExternalStorageDir because: ${JSON.stringify(error)}`);
  }
}

environment.getUserHomeDir¹¹⁺

getUserHomeDir(): string

Obtains the sandbox path of the built-in card directory of the current user. This API is available only to certain devices.

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

System capability: SystemCapability.FileManagement.File.Environment.FolderObtain

System API: This is a system API.

Return value

Error codes

For details about the error codes, see File Management Error Codes.

Example

import { BusinessError } from '@ohos.base';
function getUserHomeDirExample() {
  try {
    let path = environment.getUserHomeDir();
    console.log(`success to getUserHomeDir: ${JSON.stringify(path)}`);
  } catch (error) {
    console.error(`failed to getUserHomeDir because: ${JSON.stringify(error)}`);
  }
}