env.h File Reference

Environment handling. More...

#include "dist/sds/sds.h"
#include "src/lib/validate.h"
#include <stdbool.h>

Include dependency graph for env.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
const char *	getenv_check (const char *env_var)
sds	getenv_string (const char *env_var, const char *default_value, validate_callback vcb, bool *rc)
int	getenv_int (const char *env_var, int default_value, int min, int max, bool *rc)
unsigned	getenv_uint (const char *env_var, unsigned default_value, unsigned min, unsigned max, bool *rc)
bool	getenv_bool (const char *env_var, bool default_value, bool *rc)

Detailed Description

Environment handling.

Function Documentation

getenv_bool()

bool getenv_bool	(	const char *	env_var,
		bool	default_value,
		bool *	rc )

Gets an environment variable as bool

Parameters

env_var	variable name to read
default_value	default value if variable is not set
rc	Pointer to bool to set return code

Returns

environment variable as bool or default_value if validation fails

getenv_check()

const char * getenv_check

(

const char *

env_var

)

Gets an environment variable and checks its length

Parameters

env_var

environment variable name

Returns

environment variable value or NULL if it is not set or too long

getenv_int()

int getenv_int	(	const char *	env_var,
		int	default_value,
		int	min,
		int	max,
		bool *	rc )

Gets an environment variable as int

Parameters

env_var	variable name to read
default_value	default value if variable is not set
min	minimum value (including)
max	maximum value (including)
rc	Pointer to bool to set return code

Returns

environment variable as integer or default_value if validation fails

getenv_string()

sds getenv_string	(	const char *	env_var,
		const char *	default_value,
		validate_callback	vcb,
		bool *	rc )

Gets an environment variable as sds string

Parameters

env_var	variable name to read
default_value	default value if variable is not set
vcb	validation callback
rc	Pointer to bool to set return code

Returns

environment variable as sds string or default_value if validation fails

getenv_uint()

unsigned getenv_uint	(	const char *	env_var,
		unsigned	default_value,
		unsigned	min,
		unsigned	max,
		bool *	rc )

Gets an environment variable as int

Parameters

env_var	variable name to read
default_value	default value if variable is not set
min	minimum value (including)
max	maximum value (including)
rc	Pointer to bool to set return code

Returns

environment variable as unsigned integer or default_value if validation fails