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 home2l.EnvBuildOS

(

)

EnvBuildOS() -> char const *

EnvBuildArch()

def home2l.EnvBuildArch

(

)

EnvBuildArch() -> char const *

EnvMachineName()

def home2l.EnvMachineName

(

)

EnvMachineName() -> char const *

EnvExecPathName()

def home2l.EnvExecPathName

(

)

EnvExecPathName() -> char const *

EnvExecName()

def home2l.EnvExecName

(

)

EnvExecName() -> char const *

EnvInstanceName()

def home2l.EnvInstanceName

(

)

EnvInstanceName() -> char const *

EnvDroidId()

def home2l.EnvDroidId

(

)

EnvDroidId() -> char const *

EnvPid()

def home2l.EnvPid

(

)

EnvPid() -> int

EnvHaveTerminal()

def home2l.EnvHaveTerminal

(

)

EnvHaveTerminal() -> bool

EnvReadIniFile()

def home2l.EnvReadIniFile	(		fileName,
			map
	)

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

EnvHome2lRoot()

def home2l.EnvHome2lRoot

(

)

EnvHome2lRoot() -> char const *

EnvHome2lEtc()

def home2l.EnvHome2lEtc

(

)

EnvHome2lEtc() -> char const *

EnvHome2lVar()

def home2l.EnvHome2lVar

(

)

EnvHome2lVar() -> char const *

EnvHome2lTmp()

def home2l.EnvHome2lTmp

(

)

EnvHome2lTmp() -> char const *

EnvGetHome2lRootPath()

def home2l.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 home2l.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 home2l.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 home2l.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 home2l.EnvMkVarDir

(

relOrAbsPath

)

EnvMkVarDir(char const * relOrAbsPath) -> bool

EnvMkTmpDir()

def home2l.EnvMkTmpDir

(

relOrAbsPath

)

EnvMkTmpDir(char const * relOrAbsPath) -> bool

EnvNetResolve()

def home2l.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 home2l.EnvLocationLatitudeN

(

)

EnvLocationLatitudeN() -> float

EnvLocationLongitudeE()

def home2l.EnvLocationLongitudeE

(

)

EnvLocationLongitudeE() -> float

EnvInit()

def home2l.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 home2l.EnvPrintBanner

(

)

EnvPrintBanner()

EnvDone()

def home2l.EnvDone

(

)

EnvDone()

EnvEnablePersistence()

def home2l.EnvEnablePersistence	(		writeThrough = True,
			_varFileName = None
	)

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

EnvFlush()

def home2l.EnvFlush

(

)

EnvFlush()

EnvGet()

def home2l.EnvGet

(

key

)

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

EnvPut()

def home2l.EnvPut

(

*

args

)

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

EnvDel()

def home2l.EnvDel

(

key

)

EnvDel(char const * key)