---

PassguardErrorManager Class Reference

Manage all error messages of the Framework. More...

#include <PassguardErrorManager.h>

Inheritance diagram for PassguardErrorManager:

List of all members.

Public Methods
	~PassguardErrorManager ()
	The Destructor of the error manager. More...
string	getErrorMessage (string function_name) const
	Retreive the last error message of the function named function_name. More...
string	getLastErrorMessage (string *function_name)
	Retreive the last error message of the last function that have generated an error. More...
string	getHelpMessage (string function_name) const
	Retreive the last help message of the function named function_name. More...
string	getLastHelpMessage (string *function_name)
	Retreive the last help message of the last function that have generated an error. More...
Protected Methods
	PassguardErrorManager ()
	The constructor of the error manager. More...
void	setErrorMessage (string function_name, string error_message, string help_message="")
	Set the error message relative to a function of the class. More...

---

Detailed Description

Manage all error messages of the Framework.

---

Constructor & Destructor Documentation

PassguardErrorManager::~PassguardErrorManager (    )

The Destructor of the error manager. Returns: none

PassguardErrorManager::PassguardErrorManager (    )  [protected]

The constructor of the error manager. Returns: none

---

Member Function Documentation

string PassguardErrorManager::getErrorMessage (  string    function_name )  const

Retreive the last error message of the function named function_name. Parameters: function_name  the name of the function you want the last error message Returns: the appropriate message if one or an empty string otherwise

string PassguardErrorManager::getHelpMessage (  string    function_name )  const

Retreive the last help message of the function named function_name. this message will give more information about the error that occured Parameters: function_name  the name of the function you want the last error message Returns: the appropriate help message if one or an empty string otherwise

string PassguardErrorManager::getLastErrorMessage (  string *    function_name )

Retreive the last error message of the last function that have generated an error. Parameters: function_name  if not NULL, it will be filled with the name of the function that has generated this error message Returns: the last error message generated by this class or an empty string if none

string PassguardErrorManager::getLastHelpMessage (  string *    function_name )

Retreive the last help message of the last function that have generated an error. this message will give more information about the error that occured Parameters: function_name  if not NULL, it will be filled with the name of the function that has generated this error message Returns: the last help message generated by this class or an empty string if none

void PassguardErrorManager::setErrorMessage (  string    function_name, string    error_message, string    help_message = "" )  [protected]

Set the error message relative to a function of the class. Parameters: function_name  the name of the function that has generated the error error_message  the error message explaining the error that has occured help_message  the error message explaining the error that has occured (optional, default is "") Returns: none

---

The documentation for this class was generated from the following files:

• PassguardErrorManager.h
• PassguardErrorManager.cpp

---