HGL::Exception::PoptExitException Class Reference
[Exceptions, Command line options support]

Exception to indicate that HGL has to successfully terminate after processing an command line argument. More...

#include <poptexitexception.h>

List of all members.

Public Member Functions
	PoptExitException (int ret=EXIT_SUCCESS) throw ()
	Constructs an PoptExitException.
int	getReturnCode () throw ()
	Gets the return value with which the application should exit.

---

Detailed Description

Exception to indicate that HGL has to successfully terminate after processing an command line argument.

Some command line arguments show only information and than want to exit. For this case they should throw this exception to indicate HGL it can terminate gracefully without doing further action.

Author:

Heiko Schäfer <heiko@hgl.rangun.de> BSD License

Since:

0.4.65

---

Constructor & Destructor Documentation

HGL::Exception::PoptExitException::PoptExitException

(

int

ret = EXIT_SUCCESS

)

throw ()

Constructs an PoptExitException.

Parameters:

ret

the return value with which the application should exit

Since:

0.5.19

---

Member Function Documentation

int HGL::Exception::PoptExitException::getReturnCode

(

)

throw ()

Gets the return value with which the application should exit.

Parameters:

ret

the return value with which the application should exit

Since:

0.5.19