- Main Page
- Related Pages
- Modules
- Classes
- Files

# ConnectionException.h

Go to the documentation of this file.

    00001 #ifndef _CONNECTIONEXCEPTION_H_
    00002 #define _CONNECTIONEXCEPTION_H_
    00003 //
    00004
    00005 //
    00006 // Copyright (C) 2004-2006  Autodesk, Inc.
    00007 //
    00008 // This library is free software; you can redistribute it and/or
    00009 // modify it under the terms of version 2.1 of the GNU Lesser
    00010 // General Public License as published by the Free Software Foundation.
    00011 //
    00012 // This library is distributed in the hope that it will be useful,
    00013 // but WITHOUT ANY WARRANTY; without even the implied warranty of
    00014 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    00015 // Lesser General Public License for more details.
    00016 //
    00017 // You should have received a copy of the GNU Lesser General Public
    00018 // License along with this library; if not, write to the Free Software
    00019 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    00020 //
    00021
    00022 #ifdef _WIN32
    00023 #pragma once
    00024 #endif
    00025
    00026 #include <FdoStd.h>
    00027
    00028 /// \brief
    00029 /// The FdoConnectionException class is the exception type thrown from classes in the Connections package.
    00030 /// ConnectionException derives from a language level exception class that is environment-
    00031 /// specific.
    00032 class FdoConnectionException : public FdoException
    00033 {
    00034 /// \cond DOXYGEN-IGNORE
    00035 protected:
    00036     /// \brief
    00037     /// Constructs a default instance of an FdoConnectionException.
    00038     ///
    00039     /// \return
    00040     /// Returns nothing
    00041     ///
    00042     FDO_API FdoConnectionException();
    00043
    00044     /// \brief
    00045     /// Constructs an instance of an FdoConnectionException using the specified arguments.
    00046     ///
    00047     /// \param message
    00048     /// Input the error message
    00049     ///
    00050     /// \return
    00051     /// Returns nothing
    00052     ///
    00053     FDO_API FdoConnectionException(FdoString* message);
    00054
    00055     /// \brief
    00056     /// Constructs an instance of an FdoConnectionException using the specified arguments.
    00057     ///
    00058     /// \param message
    00059     /// Input the error message
    00060     /// \param cause
    00061     /// Input the cause of the error
    00062     ///
    00063     /// \return
    00064     /// Returns nothing
    00065     ///
    00066     FDO_API FdoConnectionException(FdoString* message, FdoException* cause);
    00067
    00068     /// \brief
    00069     /// Default destructor for FdoConnectionException class.
    00070     ///
    00071     /// \return
    00072     /// Returns nothing
    00073     ///
    00074     FDO_API virtual ~FdoConnectionException();
    00075
    00076     FDO_API virtual void Dispose();
    00077 /// \endcond
    00078
    00079 public:
    00080     /// \brief
    00081     /// Returns a default instance of an FdoConnectionException.
    00082     ///
    00083     /// \return
    00084     /// Returns FdoConnectionException
    00085     ///
    00086     FDO_API static FdoConnectionException* Create();
    00087
    00088     /// \brief
    00089     ///  Returns an instance of an FdoConnectionException using the specified arguments.
    00090     ///
    00091     /// \param message
    00092     /// Input the error message.
    00093     ///
    00094     /// \return
    00095     /// Returns FdoConnectionException.
    00096     ///
    00097     FDO_API static FdoConnectionException* Create(FdoString* message);
    00098
    00099     /// \brief
    00100     ///  Returns an instance of an FdoConnectionException using the specified arguments.
    00101     ///
    00102     /// \param message
    00103     /// Input the error message.
    00104     /// \param cause
    00105     /// Input the cause of the error.
    00106     ///
    00107     /// \return
    00108     /// Returns FdoConnectionException
    00109     ///
    00110     FDO_API static FdoConnectionException* Create(FdoString* message, FdoException* cause);
    00111 };
    00112 #endif
    00113
    00114

Please send us your comment about this page