Public API Reference

                 

---

csVariant Struct Reference
[Utilities]

Variant, means that type of contained data is set at runtime. More...

#include <config.h>

List of all members.

Public Methods
void	SetLong (long l)
	Assign a long. More...
void	SetBool (bool b)
	Assign a bool. More...
void	SetFloat (float f)
	Assign a float. More...
void	SetString (const char *s)
	Assign a string. More...
void	SetCommand ()
	Assign a command. More...
long	GetLong () const
	Retrieve a long. More...
bool	GetBool () const
	Retrieve a bool. More...
float	GetFloat () const
	Retrieve a float. More...
const char *	GetString () const
	Retrieve a string. More...

---

Detailed Description

Variant, means that type of contained data is set at runtime.

Be aware that requesting another type than the containing one will trigger an assertion!

Definition at line 49 of file config.h.

---

Member Function Documentation

bool csVariant::GetBool (    )  const [inline]

Retrieve a bool. Definition at line 109 of file config.h. References CSVAR_BOOL.

float csVariant::GetFloat (    )  const [inline]

Retrieve a float. Definition at line 115 of file config.h. References CSVAR_FLOAT.

long csVariant::GetLong (    )  const [inline]

Retrieve a long. Definition at line 103 of file config.h. References CSVAR_LONG.

const char* csVariant::GetString (    )  const [inline]

Retrieve a string. Definition at line 121 of file config.h. References CSVAR_STRING.

void csVariant::SetBool (  bool    b )  [inline]

Assign a bool. Definition at line 72 of file config.h. References CSVAR_BOOL, and CSVAR_STRING.

void csVariant::SetCommand (    )  [inline]

Assign a command. Definition at line 96 of file config.h. References CSVAR_CMD, and CSVAR_STRING.

void csVariant::SetFloat (  float    f )  [inline]

Assign a float. Definition at line 79 of file config.h. References CSVAR_FLOAT, and CSVAR_STRING.

void csVariant::SetLong (  long    l )  [inline]

Assign a long. Definition at line 65 of file config.h. References CSVAR_LONG, and CSVAR_STRING.

void csVariant::SetString (  const char *    s )  [inline]

Assign a string. Definition at line 86 of file config.h. References csStrNew, and CSVAR_STRING.

---

The documentation for this struct was generated from the following file:

• config.h

---