## Overview

This module provides APIs to retrieve information about the environment variables and the current users of the Operating System.

The APIs are platform-independent, i.e., uniform across all operating systems.

For information on the operations, which you can perform with the `os` module, see the below **Functions**.


Error

Returns the environment variable value associated with the provided name.
```ballerina
string port = os:getEnv("HTTP_PORT");
```



getEnv

name

string

Environment variable value if it exists or else, an empty string


Returns the current user's home directory path.
```ballerina
string userHome = os:getUserHome();
```



getUserHome

Current user's home directory if it can be determined or else, an empty string


Returns the current user's name.
```ballerina
string username = os:getUsername();
```



getUsername

Current user's name if it can be determined or else, an empty string


Returns a map of environment variables.
```ballerina
map<string> envs = os:listEnv();
```



listEnv

Sets the value of the environment variable named by the key. 
Note that the parameter key cannot be an empty string or "==" sign.
```ballerina
os:Error? err = os:setEnv("BALCONFIGFILE", "/path/to/Config.toml");
```



setEnv

value

An `os:Error` if setting the environment variable fails, () otherwise


Removes a single environment variable from the system if it exists.
Note that the parameter key cannot be an empty string.
```ballerina
os:Error? err = os:unsetEnv("BALCONFIGFILE");
```



unsetEnv

An `os:Error` if unsetting the environment variable fails, () otherwise


This module provides APIs to retrieve information about the environment variables and the current users of the Operating System.


ballerina/os
1.3.0
1.3.0 1.2.1 1.2.0 1.1.0 1.0.1 1.0.0 0.8.0-beta.2 0.8.0-beta.1 0.8.0-alpha8

Overview

Functions

Errors

ballerina/os1.3.01.3.01.2.11.2.01.1.01.0.11.0.00.8.0-beta.20.8.0-beta.10.8.0-alpha8

Overview

Functions

Errors

ballerina/os
1.3.0
1.3.0 1.2.1 1.2.0 1.1.0 1.0.1 1.0.0 0.8.0-beta.2 0.8.0-beta.1 0.8.0-alpha8