NDEVR
API Documentation
CancelException

An Exception thrown when the user cancels an operation. More...

Inheritance diagram for CancelException:
[legend]
Collaboration diagram for CancelException:
[legend]

Public Member Functions

 CancelException ()
 Constructs a CancelException with a default cancellation message.
 CancelException (const TranslatedString &message)
 Constructs a CancelException with a custom cancellation message.

Detailed Description

An Exception thrown when the user cancels an operation.


This is not a true error but designed to be used in control paths that allow users to cancel activities.

Definition at line 98 of file Exception.h.

Constructor & Destructor Documentation

◆ CancelException()

CancelException::CancelException ( const TranslatedString & message)

Constructs a CancelException with a custom cancellation message.

Parameters
[in]messageA translated description of the cancellation reason.

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