Description

Access configuration parameters and query environment properties.

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

Functions
	EnvBuildOS ()

	EnvBuildArch ()

	EnvMachineName ()

	EnvExecPathName ()

	EnvExecName ()

	EnvInstanceName ()

	EnvDroidId ()

	EnvPid ()

	EnvHaveTerminal ()

	EnvReadIniFile (fileName, map)

	EnvHome2lRoot ()

	EnvHome2lEtc ()

	EnvHome2lVar ()

	EnvHome2lTmp ()

	EnvGetHome2lRootPath (relOrAbsPath)

	EnvGetHome2lEtcPath (relOrAbsPath)

	EnvGetHome2lVarPath (relOrAbsPath)

	EnvGetHome2lTmpPath (relOrAbsPath)

	EnvMkVarDir (relOrAbsPath)

	EnvMkTmpDir (relOrAbsPath)

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

	EnvLocationLatitudeN ()

	EnvLocationLongitudeE ()

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

	EnvPrintBanner ()

	EnvDone ()

	EnvEnablePersistence (writeThrough=True, _varFileName=None)

	EnvFlush ()

	EnvGet (key)

	EnvPut (*args)

	EnvDel (key)

Function Documentation

◆ EnvBuildOS()

EnvBuildOS ( )

EnvBuildOS() -> char const *

◆ EnvBuildArch()

EnvBuildArch ( )

EnvBuildArch() -> char const *

◆ EnvMachineName()

EnvMachineName ( )

EnvMachineName() -> char const *

◆ EnvExecPathName()

EnvExecPathName ( )

EnvExecPathName() -> char const *

◆ EnvExecName()

EnvExecName ( )

EnvExecName() -> char const *

◆ EnvInstanceName()

EnvInstanceName ( )

EnvInstanceName() -> char const *

◆ EnvDroidId()

EnvDroidId ( )

EnvDroidId() -> char const *

◆ EnvPid()

EnvPid ( )

EnvPid() -> int

◆ EnvHaveTerminal()

EnvHaveTerminal ( )

EnvHaveTerminal() -> bool

◆ EnvReadIniFile()

EnvReadIniFile	(	fileName,
		map
	)

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

◆ EnvHome2lRoot()

EnvHome2lRoot ( )

EnvHome2lRoot() -> char const *

◆ EnvHome2lEtc()

EnvHome2lEtc ( )

EnvHome2lEtc() -> char const *

◆ EnvHome2lVar()

EnvHome2lVar ( )

EnvHome2lVar() -> char const *

◆ EnvHome2lTmp()

EnvHome2lTmp ( )

EnvHome2lTmp() -> char const *

◆ EnvGetHome2lRootPath()

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()

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()

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()

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()

EnvMkVarDir ( relOrAbsPath )

EnvMkVarDir(char const * relOrAbsPath) -> bool

◆ EnvMkTmpDir()

EnvMkTmpDir ( relOrAbsPath )

EnvMkTmpDir(char const * relOrAbsPath) -> bool

◆ EnvNetResolve()

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()

EnvLocationLatitudeN ( )

EnvLocationLatitudeN() -> float

◆ EnvLocationLongitudeE()

EnvLocationLongitudeE ( )

EnvLocationLongitudeE() -> float

◆ EnvInit()

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()

EnvPrintBanner ( )

EnvPrintBanner()

◆ EnvDone()

EnvDone ( )

EnvDone()

◆ EnvEnablePersistence()

EnvEnablePersistence	(	writeThrough = `True`,
		_varFileName = `None`
	)

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

◆ EnvFlush()

EnvFlush ( )

EnvFlush()

◆ EnvGet()

EnvGet ( key )

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

◆ EnvPut()

EnvPut ( * args )

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

◆ EnvDel()

EnvDel ( key )

EnvDel(char const * key)