00001 /* ///////////////////////////////////////////////////////////////////////// 00002 * File: comstl/error/excepinfo_functions.h 00003 * 00004 * Purpose: EXCEPINFO functions. 00005 * 00006 * Created: 11th August 2007 00007 * Updated: 27th April 2010 00008 * 00009 * Home: http://stlsoft.org/ 00010 * 00011 * Copyright (c) 2007-2010, Matthew Wilson and Synesis Software 00012 * All rights reserved. 00013 * 00014 * Redistribution and use in source and binary forms, with or without 00015 * modification, are permitted provided that the following conditions are met: 00016 * 00017 * - Redistributions of source code must retain the above copyright notice, this 00018 * list of conditions and the following disclaimer. 00019 * - Redistributions in binary form must reproduce the above copyright notice, 00020 * this list of conditions and the following disclaimer in the documentation 00021 * and/or other materials provided with the distribution. 00022 * - Neither the name(s) of Matthew Wilson and Synesis Software nor the names of 00023 * any contributors may be used to endorse or promote products derived from 00024 * this software without specific prior written permission. 00025 * 00026 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 00027 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00028 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 00029 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 00030 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 00031 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 00032 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 00033 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 00034 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 00035 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 00036 * POSSIBILITY OF SUCH DAMAGE. 00037 * 00038 * ////////////////////////////////////////////////////////////////////// */ 00039 00040 00047 #ifndef COMSTL_INCL_COMSTL_ERROR_H_EXCEPINFO_FUNCTIONS 00048 #define COMSTL_INCL_COMSTL_ERROR_H_EXCEPINFO_FUNCTIONS 00049 00050 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION 00051 # define COMSTL_VER_COMSTL_ERROR_H_EXCEPINFO_FUNCTIONS_MAJOR 1 00052 # define COMSTL_VER_COMSTL_ERROR_H_EXCEPINFO_FUNCTIONS_MINOR 0 00053 # define COMSTL_VER_COMSTL_ERROR_H_EXCEPINFO_FUNCTIONS_REVISION 3 00054 # define COMSTL_VER_COMSTL_ERROR_H_EXCEPINFO_FUNCTIONS_EDIT 4 00055 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ 00056 00057 /* ///////////////////////////////////////////////////////////////////////// 00058 * Includes 00059 */ 00060 00061 #ifndef COMSTL_INCL_COMSTL_H_COMSTL 00062 # include <comstl/comstl.h> 00063 #endif /* !COMSTL_INCL_COMSTL_H_COMSTL */ 00064 #ifndef COMSTL_INCL_COMSTL_STRING_H_BSTR_FUNCTIONS 00065 # include <comstl/string/BSTR_functions.h> 00066 #endif /* !COMSTL_INCL_COMSTL_STRING_H_BSTR_FUNCTIONS */ 00067 00068 /* ///////////////////////////////////////////////////////////////////////// 00069 * Namespace 00070 */ 00071 00072 #if !defined(_COMSTL_NO_NAMESPACE) && \ 00073 !defined(STLSOFT_DOCUMENTATION_SKIP_SECTION) 00074 # if defined(_STLSOFT_NO_NAMESPACE) 00075 /* There is no stlsoft namespace, so must define ::comstl */ 00076 namespace comstl 00077 { 00078 # else 00079 /* Define stlsoft::comstl_project */ 00080 00081 namespace stlsoft 00082 { 00083 00084 namespace comstl_project 00085 { 00086 00087 # endif /* _STLSOFT_NO_NAMESPACE */ 00088 #endif /* !_COMSTL_NO_NAMESPACE */ 00089 00090 /* ///////////////////////////////////////////////////////////////////////// 00091 * C functions 00092 */ 00093 00094 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION 00095 00096 STLSOFT_INLINE void comstl_c_EXCEPINFO_free(EXCEPINFO *pxi) 00097 { 00098 /* Precondition tests */ 00099 COMSTL_ASSERT(NULL != pxi); 00100 00101 comstl__bstr_destroy(pxi->bstrSource); 00102 pxi->bstrSource = NULL; 00103 comstl__bstr_destroy(pxi->bstrDescription); 00104 pxi->bstrDescription = NULL; 00105 comstl__bstr_destroy(pxi->bstrHelpFile); 00106 pxi->bstrHelpFile = NULL; 00107 } 00108 00109 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ 00110 00111 /* ///////////////////////////////////////////////////////////////////////// 00112 * Namespace 00113 */ 00114 00115 #ifdef STLSOFT_DOCUMENTATION_SKIP_SECTION 00116 namespace comstl 00117 { 00118 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */ 00119 00120 /* ///////////////////////////////////////////////////////////////////////// 00121 * C++ functions 00122 */ 00123 00124 #ifdef __cplusplus 00125 00129 inline void EXCEPINFO_free(EXCEPINFO* pxi) 00130 { 00131 comstl_c_EXCEPINFO_free(pxi); 00132 } 00133 00134 #endif /* __cplusplus */ 00135 00136 /* ///////////////////////////////////////////////////////////////////////// 00137 * Unit-testing 00138 */ 00139 00140 #ifdef STLSOFT_UNITTEST 00141 # include "./unittest/excepinfo_functions_unittest_.h" 00142 #endif /* STLSOFT_UNITTEST */ 00143 00144 /* ////////////////////////////////////////////////////////////////////// */ 00145 00146 #ifndef _COMSTL_NO_NAMESPACE 00147 # if defined(_STLSOFT_NO_NAMESPACE) || \ 00148 defined(STLSOFT_DOCUMENTATION_SKIP_SECTION) 00149 } /* namespace comstl */ 00150 # else 00151 } /* namespace comstl_project */ 00152 } /* namespace stlsoft */ 00153 # endif /* _STLSOFT_NO_NAMESPACE */ 00154 #endif /* !_COMSTL_NO_NAMESPACE */ 00155 00156 /* ////////////////////////////////////////////////////////////////////// */ 00157 00158 #endif /* !COMSTL_INCL_COMSTL_ERROR_H_EXCEPINFO_FUNCTIONS */ 00159 00160 /* ///////////////////////////// end of file //////////////////////////// */