env_settings.h File Reference

Go to the source code of this file.

Functions
unsigned long long	GetUnsignedLongLongSetting (const char *name, unsigned long long def)
	Loads an integer setting from the environment.
long	GetLongSetting (const char *name, long def)
	Loads an integer setting from the environment.
int	GetIntSetting (const char *name, int def)
	Loads an integer setting from the environment.
double	GetDoubleSetting (const char *name, double def)
	Loads a floating-point setting from the environment.
const char *	GetStringSetting (const char *name, const char *def)
	Loads a setting from the environment.
const char *	GetExecutablePathSetting (const char *name, const char *def, int is_auth)
	Loads a setting from the environment that specifies a binary name.

Function Documentation

GetDoubleSetting()

double GetDoubleSetting	(	const char *	name,
		double	def )

Loads a floating-point setting from the environment.

Parameters

name	The setting to read (with XSECURELOCK_ variable name prefix).
def	The default value.

Returns

The value of the setting, or def if unset or not a number.

GetExecutablePathSetting()

const char * GetExecutablePathSetting	(	const char *	name,
		const char *	def,
		int	is_auth )

Loads a setting from the environment that specifies a binary name.

Parameters

name	The setting to read (with XSECURELOCK_ variable name prefix).
def	The default value.
is_auth	If the path should be an auth child.

Returns

The value of the setting, or def if unset, invalid or empty.

GetIntSetting()

int GetIntSetting	(	const char *	name,
		int	def )

Loads an integer setting from the environment.

Parameters

name	The setting to read (with XSECURELOCK_ variable name prefix).
def	The default value.

Returns

The value of the setting, or def if unset or not a number.

GetLongSetting()

long GetLongSetting	(	const char *	name,
		long	def )

Loads an integer setting from the environment.

Parameters

name	The setting to read (with XSECURELOCK_ variable name prefix).
def	The default value.

Returns

The value of the setting, or def if unset or not a number.

GetStringSetting()

const char * GetStringSetting	(	const char *	name,
		const char *	def )

Loads a setting from the environment.

Parameters

name	The setting to read (with XSECURELOCK_ variable name prefix).
def	The default value.

Returns

The value of the setting, or def if unset or empty.

GetUnsignedLongLongSetting()

unsigned long long GetUnsignedLongLongSetting	(	const char *	name,
		unsigned long long	def )

Loads an integer setting from the environment.

Parameters

name	The setting to read (with XSECURELOCK_ variable name prefix).
def	The default value.

Returns

The value of the setting, or def if unset or not a number.