get_env.h File Reference

#include "rcutils/macros.h"
#include "rcutils/visibility_control.h"

Include dependency graph for get_env.h:

Go to the source code of this file.

Functions
const char *	rcutils_get_env (const char *env_name, const char **env_value)
	Retrieve the value of the given environment variable if it exists, or "". More...
const char *	rcutils_get_home_dir (void)
	Retrieve the full path to the home directory. More...

Function Documentation

rcutils_get_env()

const char* rcutils_get_env	(	const char *	env_name,
		const char **	env_value
	)

Retrieve the value of the given environment variable if it exists, or "".

rcutils_get_home_dir()

const char* rcutils_get_home_dir

(

void

)

Retrieve the full path to the home directory.

The c-string which is returned is only valid until the next time this function is called, because it is a direct pointer to the static storage. Also note that the string returned here should not be freed.

The function first tries to get the HOME environment variable. If that variable exists and is non-empty, that will be returned. Otherwise, the function tries to get the USERPROFILE environment variable. If that variable exists and is non-empty, that will be returned. If neither exists, NULL will be returned. The above algorithm is portable across both Unix and Windows.

The home directory will be truncated at 2048 characters on Windows.

This function is not thread-safe.

Returns

The home directory on success, NULL on failure.