3.5. Environment Functions

3.5. Environment Functions
Prev	Chapter 3. Function Library	Next

Synopsis

Retrieves the environment variable passed as an argument.

Prototype

*string getenv(string) (CONST)

Example

my *string $v = getenv("PATH");

Table 3.99. Arguments and Return Values for getenv()

Argument Type	Return Type	Description
`string`	`*string`	The contents of the environment variable are returned as a string, if the environment variable exists, otherwise no value is returned.

This function does not throw any exceptions.

Synopsis

Sets an environment variable to a value.

To unset or clear an environment variable, see unsetenv().

Prototype

int setenv(string $var, softstring $value)

Example

setenv("PATH", "/bin:/usr/bin");

Table 3.100. Arguments and Return Values for setenv()

Argument Type	Return Type	Description
`string $var, softstring $value`	`int`	Sets the environment variable to a string value (the value is converted to a string if necessary).

This function does not throw any exceptions.

Synopsis

Unsets an environment variable.

To set an environment variable, see setenv().

Prototype

int unsetenv(string)

Example

unsetenv("PATH");

Table 3.101. Arguments and Return Values for unsetenv()

Argument Type	Return Type	Description
`string`	`int`	Unsets the environment variable given by the string passed.

This function does not throw any exceptions.

This function is only supported on systems where the C library support for unsetenv() is present.

Prev	Up	Next
3.4. Qore Type Functions	Home	3.6. String Functions