OpenGL Vizserver Reference Page

NAME

vsAuthField - Container for authentication data

HEADER FILE

#include <vizserver/vsAuth.h>

PUBLIC METHOD SUMMARY

   Creating and Destroying

vsAuthField (

const char* name, const char* defValue=NULL, vsBool aSecret=FALSE);

~vsAuthField (

);

   Setting and Getting

const char* getName (

) const;

void setValue (

const char* value);

const char* getValue (

) const;

vsBool isSecret (

) const;

CLASS DESCRIPTION

This class is a container for authentication data fields. Data includes name of the field, data contained by the field, and privacy information.

METHOD DESCRIPTIONS

   vsAuthField()

vsAuthField (

const char* name, const char* defValue=NULL, vsBool aSecret=FALSE);

Constructor to initialize a field name. Default parameters for the initial value and secret fields provide consistant initialization.

   ~vsAuthField()

~vsAuthField (

);

Destructor releases any storage directly allocated with this object.

   getName()

const char* getName (

) const;

Returns the name of the field.

   getValue()

const char* getValue (

) const;

Returns the value associated with the field.

   isSecret()

vsBool isSecret (

) const;

Returns a boolean if the field in question is a "secret" field.

   setValue()

void setValue (

const char* value);

Sets the name of the value corresponding to the field.

---