| FDO API Reference | Feature Data Objects |
00001 #ifndef _COMMANDEXCEPTION_ 00002 #define _COMMANDEXCEPTION_ 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 FdoCommandException class is the exception type thrown from classes in the Data package. 00030 /// FdoCommandException derives from a language level exception class that is environment 00031 /// specific. 00032 class FdoCommandException : public FdoException 00033 { 00034 protected: 00035 /// \brief 00036 /// Constructs a default instance of an FdoCommandException. 00037 /// 00038 /// \return 00039 /// Returns nothing 00040 /// 00041 FDO_API FdoCommandException(); 00042 00043 /// \brief 00044 /// Constructs an instance of an FdoCommandException using the specified arguments. 00045 /// 00046 /// \return 00047 /// Returns nothing 00048 /// 00049 FDO_API FdoCommandException(FdoString* message); 00050 00051 /// \brief 00052 /// Constructs an instance of an FdoCommandException using the specified arguments. 00053 /// 00054 /// \param message 00055 /// Input the error message 00056 /// \param cause 00057 /// Input the cause of the error 00058 /// 00059 /// \return 00060 /// Returns nothing 00061 /// 00062 FDO_API FdoCommandException(FdoString* message, FdoException* cause); 00063 00064 /// \brief 00065 /// Default destructor for CommandException. 00066 /// 00067 /// \return 00068 /// Returns nothing 00069 /// 00070 FDO_API virtual ~FdoCommandException(); 00071 00072 /// \brief 00073 /// Dispose of this object 00074 /// 00075 /// \return 00076 /// Returns nothing 00077 /// 00078 FDO_API virtual void Dispose(); 00079 00080 public: 00081 /// \brief 00082 /// Returns a default instance of an FdoCommandException. 00083 /// 00084 /// \return 00085 /// Returns FdoCommandException object 00086 /// 00087 FDO_API static FdoCommandException* Create(); 00088 00089 /// \brief 00090 /// Returns an instance of an FdoCommandException using the specified arguments. 00091 /// 00092 /// \param message 00093 /// Input the error message 00094 /// 00095 /// \return 00096 /// Returns FdoCommandException object 00097 /// 00098 FDO_API static FdoCommandException* Create(FdoString* message); 00099 00100 /// \brief 00101 /// Returns an instance of an FdoCommandException using the specified arguments. 00102 /// 00103 /// \param message 00104 /// Input the error message 00105 /// \param cause 00106 /// Input the cause of the error 00107 /// 00108 /// \return 00109 /// Returns FdoCommandException object 00110 /// 00111 FDO_API static FdoCommandException* Create(FdoString* message, FdoException* cause); 00112 }; 00113 00114 /// \brief 00115 /// FdoCommandExceptionP is a FdoPtr on FdoCommandException, provided for convenience. 00116 typedef FdoPtr<FdoCommandException> FdoCommandExceptionP; 00117 00118 #endif 00119 00120
| Comments or suggestions? Send us feedback. |