Environment

Description

Access configuration parameters and query environment properties.

More detailed information on these functions can be found in the C/C++ API documentation.

Functions
def	EnvBuildOS ()
def	EnvBuildArch ()
def	EnvMachineName ()
def	EnvExecPathName ()
def	EnvExecName ()
def	EnvInstanceName ()
def	EnvDroidId ()
def	EnvPid ()
def	EnvHaveTerminal ()
def	EnvReadIniFile (fileName, map)
def	EnvHome2lRoot ()
def	EnvHome2lEtc ()
def	EnvHome2lVar ()
def	EnvHome2lTmp ()
def	EnvGetHome2lRootPath (relOrAbsPath)
def	EnvGetHome2lEtcPath (relOrAbsPath)
def	EnvGetHome2lVarPath (relOrAbsPath)
def	EnvGetHome2lTmpPath (relOrAbsPath)
def	EnvMkVarDir (relOrAbsPath)
def	EnvMkTmpDir (relOrAbsPath)
def	EnvNetResolve (hostAndPort, retHost, retPort=None, defaultPort=0, warn=True)
def	EnvLocationLatitudeN ()
def	EnvLocationLongitudeE ()
def	EnvInit (argc, argv, specOptionsUsage=None, instanceName=None, noBanner=False)
def	EnvPrintBanner ()
def	EnvDone ()
def	EnvEnablePersistence (writeThrough=True, _varFileName=None)
def	EnvFlush ()
def	EnvGet (key)
def	EnvPut (*args)
def	EnvDel (key)

Function Documentation

EnvBuildOS()

def EnvBuildOS

(

)

EnvBuildOS() -> char const *

EnvBuildArch()

def EnvBuildArch

(

)

EnvBuildArch() -> char const *

EnvMachineName()

def EnvMachineName

(

)

EnvMachineName() -> char const *

EnvExecPathName()

def EnvExecPathName

(

)

EnvExecPathName() -> char const *

EnvExecName()

def EnvExecName

(

)

EnvExecName() -> char const *

EnvInstanceName()

def EnvInstanceName

(

)

EnvInstanceName() -> char const *

EnvDroidId()

def EnvDroidId

(

)

EnvDroidId() -> char const *

EnvPid()

def EnvPid

(

)

EnvPid() -> int

EnvHaveTerminal()

def EnvHaveTerminal

(

)

EnvHaveTerminal() -> bool

EnvReadIniFile()

def EnvReadIniFile	(		fileName,
			map
	)

EnvReadIniFile(char const * fileName, CDictCompact< CString > * map)

EnvHome2lRoot()

def EnvHome2lRoot

(

)

EnvHome2lRoot() -> char const *

EnvHome2lEtc()

def EnvHome2lEtc

(

)

EnvHome2lEtc() -> char const *

EnvHome2lVar()

def EnvHome2lVar

(

)

EnvHome2lVar() -> char const *

EnvHome2lTmp()

def EnvHome2lTmp

(

)

EnvHome2lTmp() -> char const *

EnvGetHome2lRootPath()

def EnvGetHome2lRootPath

(

relOrAbsPath

)

    EnvGetHome2lRootPath(char const * relOrAbsPath) -> char const *
    Return an absolute path name in the root domain.

    Path starting with '/' are considered already absolute and are
    returned unchanged, but normalized.

EnvGetHome2lEtcPath()

def EnvGetHome2lEtcPath

(

relOrAbsPath

)

    EnvGetHome2lEtcPath(char const * relOrAbsPath) -> char const *
    Return an absolute path name in the 'etc' domain.

    Path starting with '/' are considered already absolute and are
    returned unchanged, but normalized.

EnvGetHome2lVarPath()

def EnvGetHome2lVarPath

(

relOrAbsPath

)

    EnvGetHome2lVarPath(char const * relOrAbsPath) -> char const *
    Return an absolute path name in the 'var' domain.

    Path starting with '/' are considered already absolute and are
    returned unchanged, but normalized.

EnvGetHome2lTmpPath()

def EnvGetHome2lTmpPath

(

relOrAbsPath

)

    EnvGetHome2lTmpPath(char const * relOrAbsPath) -> char const *
    Return an absolute path name in the 'tmp' domain.

    Path starting with '/' are considered already absolute and are
    returned unchanged, but normalized.

EnvMkVarDir()

def EnvMkVarDir

(

relOrAbsPath

)

EnvMkVarDir(char const * relOrAbsPath) -> bool

EnvMkTmpDir()

def EnvMkTmpDir

(

relOrAbsPath

)

EnvMkTmpDir(char const * relOrAbsPath) -> bool

EnvNetResolve()

def EnvNetResolve	(		hostAndPort,
			retHost,
			retPort = None,
			defaultPort = 0,
			warn = True
	)

EnvNetResolve(char const * hostAndPort, CString * retHost, int * retPort=None, int defaultPort=0, bool warn=True) -> bool

EnvLocationLatitudeN()

def EnvLocationLatitudeN

(

)

EnvLocationLatitudeN() -> float

EnvLocationLongitudeE()

def EnvLocationLongitudeE

(

)

EnvLocationLongitudeE() -> float

EnvInit()

def EnvInit	(		argc,
			argv,
			specOptionsUsage = None,
			instanceName = None,
			noBanner = False
	)

EnvInit(int argc, char ** argv, char const * specOptionsUsage=None, char const * instanceName=None, bool noBanner=False)

EnvPrintBanner()

def EnvPrintBanner

(

)

EnvPrintBanner()

EnvDone()

def EnvDone

(

)

EnvDone()

EnvEnablePersistence()

def EnvEnablePersistence	(		writeThrough = True,
			_varFileName = None
	)

EnvEnablePersistence(bool writeThrough=True, char const * _varFileName=None)

EnvFlush()

def EnvFlush

(

)

EnvFlush()

EnvGet()

def EnvGet

(

key

)

    EnvGet(char const * key) -> char const *
    Get a Home2L configuration variable from the environment.

EnvPut()

def EnvPut

(

*

args

)

    EnvPut(char const * key, char const * value) -> char const
    EnvPut(char const * key, int value) -> char const *

EnvDel()

def EnvDel

(

key

)

EnvDel(char const * key)