Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIEnvironment Interface Reference

Scriptable access to the current process environment. More...

import "nsIEnvironment.idl";

Inheritance diagram for nsIEnvironment:
Inheritance graph
[legend]
Collaboration diagram for nsIEnvironment:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void set (in AString aName, in AString aValue)
 Set the value of an environment variable.
AString get (in AString aName)
 Get the value of an environment variable.
boolean exists (in AString aName)
 Check the existence of an environment variable.

Detailed Description

Scriptable access to the current process environment.

Definition at line 47 of file nsIEnvironment.idl.


Member Function Documentation

boolean nsIEnvironment::exists ( in AString  aName)

Check the existence of an environment variable.

This method checks whether an environment variable is present in the environment or not.

  • For Unix/Linux platforms we follow the Unix definition: An environment variable exists when |getenv()| returns a non-NULL value. An environment variable does not exist when |getenv()| returns NULL.
    • For non-Unix/Linux platforms we have to fall back to a "portable" definition (which is incorrect for Unix/Linux!!!!) which simply checks whether the string returned by |Get()| is empty or not.
Parameters:
aNamethe variable name to probe.
Returns:
if the variable has been set, the value returned is PR_TRUE. If the variable was not defined in the environment PR_FALSE will be returned.
AString nsIEnvironment::get ( in AString  aName)

Get the value of an environment variable.

Parameters:
aNamethe variable name to retrieve.
Returns:
returns the value of the env variable. An empty string will be returned when the env variable does not exist or when the value itself is an empty string - please use |exists()| to probe whether the env variable exists or not.
void nsIEnvironment::set ( in AString  aName,
in AString  aValue 
)

Set the value of an environment variable.

Parameters:
aNamethe variable name to set.
aValuethe value to set.

The documentation for this interface was generated from the following file: