The exception to throw when a user check on a parameter fails. More...

Public Member Functions
	UserDefinedCheckFailureException (const char paramName, const char paramValue, const char *description) throw ()
	Constructor.
	UserDefinedCheckFailureException (const UserDefinedCheckFailureException &other) throw ()
	Copy constructor.
virtual	~UserDefinedCheckFailureException () throw ()
	Destructor.
const char *	description () const throw ()
	Returns the error description.
UserDefinedCheckFailureException &	operator= (const UserDefinedCheckFailureException &other) throw ()
	Copy operator.
const char *	paramName () const throw ()
	Returns the name of the parameter.
const char *	paramValue () const throw ()
	Returns the value of the parameter.
virtual const char *	what () const throw ()
	Returns a C string describing the exception.

Detailed Description

The exception to throw when a user check on a parameter fails.

Use this when a user-defined check on a parameter fails when configuring an object. The ConfigurationHelper::throwUserConfigError() function provides a convenient way of throwing an exception of this type (see function description)

Definition at line 1018 of file configurationexceptions.h.

Constructor & Destructor Documentation

UserDefinedCheckFailureException	(	const char *	paramName,
		const char *	paramValue,
		const char *	description
	)		throw () `[inline]`

Constructor.

Parameters:

paramName	the name of the parameter on which the check failed. The buffer for this is at most 256 characters (including the '\0' terminator)
paramValue	the value of the parameter which caused the check to fail. The buffer for this is at most 256 characters (including the '\0' terminator)
description	a description of the error. The buffer for this is at most 256 characters (including the '\0' terminator)

Definition at line 1034 of file configurationexceptions.h.

UserDefinedCheckFailureException ( const UserDefinedCheckFailureException & other ) throw () [inline]

Copy constructor.

Parameters:

other the exception to copy

Definition at line 1052 of file configurationexceptions.h.

virtual ~UserDefinedCheckFailureException ( ) throw () [inline, virtual]

Destructor.

Definition at line 1092 of file configurationexceptions.h.