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

# ClientServiceException.h

Go to the documentation of this file.

    00001 #ifndef _FDOCLIENTSERVICEEXCEPTION_H_
    00002 #define _FDOCLIENTSERVICEEXCEPTION_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  *
    00023  ***************************************************************************/
    00024 #ifdef _WIN32
    00025 #pragma once
    00026 #endif
    00027
    00028 // Include definitions
    00029 #include <FdoStd.h>
    00030 #include <Fdo/ClientServices/ClientServices.h>
    00031
    00032 /// \brief
    00033 ///
    00034 /// An Exception class through which ClientServices errors are transmitted back to
    00035 /// calling applications. Derives from base FdoException class.
    00036 class FdoClientServiceException : public FdoException
    00037 {
    00038 /// \cond DOXYGEN-IGNORE
    00039 protected:
    00040     /// Constructs a default instance of a FdoClientServiceException.
    00041     FdoClientServiceException(void);
    00042
    00043     /// Constructs an instance of a FdoClientServiceException using the exception
    00044     /// message.
    00045     FdoClientServiceException(const wchar_t* message);
    00046
    00047     virtual void Dispose();
    00048 /// \endcond
    00049
    00050 public:
    00051
    00052     /// \brief
    00053     /// Default destructor for FdoClientServiceException.
    00054     ///
    00055     /// \return
    00056     /// Returns nothing.
    00057     ///
    00058     FDO_API virtual ~FdoClientServiceException(void);
    00059
    00060     /// \brief
    00061     /// Creates a default instance of a FdoClientServiceException.
    00062     ///
    00063     /// \return
    00064     /// Returns an default FdoClientServicesException object.
    00065     ///
    00066     FDO_API static FdoClientServiceException* Create();
    00067
    00068     /// \brief
    00069     /// Creates an instance of a FdoClientServiceException using the exception message.
    00070     ///
    00071     /// \param message
    00072     /// The Exception message.
    00073     ///
    00074     /// \return
    00075     /// Returns an FdoClientServicesException object containing the specified error mesage.
    00076     ///
    00077     FDO_API static FdoClientServiceException* Create(const wchar_t* message);
    00078
    00079     /// \brief
    00080     /// Gets the message associated with this exception. If no message and
    00081     /// is associated with this exception then a null reference is
    00082     /// returned.
    00083     ///
    00084     /// \return
    00085     /// Returns the error message.
    00086     ///
    00087     ///
    00088     FDO_API virtual const wchar_t* ToString();
    00089 };
    00090 #endif
    00091
    00092

Please send us your comment about this page