rtxSysInfo.h File Reference

#include "rtxsrc/osSysTypes.h"
#include "rtxsrc/rtxExternDefs.h"

Go to the source code of this file.

Functions
EXTERNRT int	rtxGetPID ()
	This function return the process ID of the currently running process.
EXTERNRT char *	rtxEnvVarDup (const char *name)
	This function make a duplicate copy of an environment variable.
EXTERNRT OSBOOL	rtxEnvVarIsSet (const char *name)
	This function tests if an environment variable is set.
EXTERNRT int	rtxEnvVarSet (const char *name, const char *value, int overwrite)
	This function sets an environment variable to the given value.

---

Detailed Description

Definition in file rtxSysInfo.h.

---

Function Documentation

EXTERNRT char* rtxEnvVarDup

(

const char *

name

)

This function make a duplicate copy of an environment variable.

The variable should be used using the standard C RTL free function (note: the OSCRTLFREE macro may be used to abstract the free function).

Parameters:

name

Name of environment variable to duplicate.

Returns:

The duplicated environment variable value.

EXTERNRT OSBOOL rtxEnvVarIsSet

(

const char *

name

)

This function tests if an environment variable is set.

Parameters:

name

Name of environment variable to test.

Returns:

True if environmental variable is set; false otherwise.

EXTERNRT int rtxEnvVarSet	(	const char *	name,
		const char *	value,
		int	overwrite
	)

This function sets an environment variable to the given value.

Parameters:

	name	Name of environment variable to test.
	value	Value to which variable should be set.
	overwrite	If non-zero, overwrite existing variable with value.

Returns:

Status of operation, 0 = success.

EXTERNRT int rtxGetPID

(

)

This function return the process ID of the currently running process.

Returns:

Process ID of currently running process.