Synesis Software STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ...

pantheios/backends/bec.COMErrorObject.h

Go to the documentation of this file.
00001 /* /////////////////////////////////////////////////////////////////////////
00002  * File:        pantheios/backends/bec.COMErrorObject.h
00003  *
00004  * Purpose:     Declaration of the Pantheios COMErrorObject Stock Back-end API.
00005  *
00006  * Created:     21st June 2005
00007  * Updated:     30th April 2010
00008  *
00009  * Home:        http://www.pantheios.org/
00010  *
00011  * Copyright (c) 2005-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
00016  * met:
00017  *
00018  * - Redistributions of source code must retain the above copyright notice,
00019  *   this list of conditions and the following disclaimer.
00020  * - Redistributions in binary form must reproduce the above copyright
00021  *   notice, this list of conditions and the following disclaimer in the
00022  *   documentation and/or other materials provided with the distribution.
00023  * - Neither the name(s) of Matthew Wilson and Synesis Software nor the
00024  *   names of any contributors may be used to endorse or promote products
00025  *   derived from this software without specific prior written permission.
00026  *
00027  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
00028  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
00029  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00030  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
00031  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00032  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00033  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00034  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00035  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00036  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00037  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00038  *
00039  * ////////////////////////////////////////////////////////////////////// */
00040 
00041 
00047 #ifndef PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_COMERROROBJECT
00048 #define PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_COMERROROBJECT
00049 
00050 /* /////////////////////////////////////////////////////////////////////////
00051  * Version information
00052  */
00053 
00054 #ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
00055 # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_COMERROROBJECT_MAJOR    3
00056 # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_COMERROROBJECT_MINOR    1
00057 # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_COMERROROBJECT_REVISION 1
00058 # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_COMERROROBJECT_EDIT     22
00059 #endif /* !PANTHEIOS_DOCUMENTATION_SKIP_SECTION */
00060 
00061 /* /////////////////////////////////////////////////////////////////////////
00062  * Includes
00063  */
00064 
00065 #ifndef PANTHEIOS_INCL_PANTHEIOS_H_PANTHEIOS
00066 # include <pantheios/pantheios.h>
00067 #endif /* !PANTHEIOS_INCL_PANTHEIOS_H_PANTHEIOS */
00068 #ifndef PANTHEIOS_INCL_PANTHEIOS_H_BACKEND
00069 # include <pantheios/backend.h>
00070 #endif /* !PANTHEIOS_INCL_PANTHEIOS_H_BACKEND */
00071 
00072 /* /////////////////////////////////////////////////////////////////////////
00073  * Documentation
00074  */
00075 
00081 /* /////////////////////////////////////////////////////////////////////////
00082  * Constants
00083  */
00084 
00099 #define PANTHEIOS_BE_COMERROROBJECT_F_DONT_OVERWRITE_EXISTING       (0x00100000)
00100 
00101 /* /////////////////////////////////////////////////////////////////////////
00102  * Typedefs
00103  */
00104 
00109 struct pan_be_COMErrorObject_init_t
00110 {
00111 #if !defined(PANTHEIOS_DOCUMENTATION_SKIP_SECTION) && \
00112     !defined(PANTHEIOS_NO_NAMESPACE)
00113     typedef pantheios::pan_uint16_t pan_uint16_t;
00114     typedef pantheios::pan_uint32_t pan_uint32_t;
00115 #endif /* !PANTHEIOS_DOCUMENTATION_SKIP_SECTION && !PANTHEIOS_NO_NAMESPACE */
00116 
00117     pan_uint32_t    version;    
00118     pan_uint32_t    flags;      
00120 #ifdef __cplusplus
00121 public: /* Construction */
00122 # ifndef PANTHEIOS_BE_INIT_NO_CPP_STRUCT_INIT
00123     pan_be_COMErrorObject_init_t();
00124 # endif /* !PANTHEIOS_BE_INIT_NO_CPP_STRUCT_INIT */
00125 #endif /* __cplusplus */
00126 };
00127 #ifndef __cplusplus
00128 typedef struct pan_be_COMErrorObject_init_t pan_be_COMErrorObject_init_t;
00129 #endif /* !__cplusplus */
00130 
00131 /* /////////////////////////////////////////////////////////////////////////
00132  * Application-defined functions
00133  */
00134 
00141 PANTHEIOS_CALL(void) pantheios_be_COMErrorObject_getAppInit(
00142     int                             backEndId
00143 ,   pan_be_COMErrorObject_init_t*   init
00144 ) /* throw() */;
00145 
00146 /* /////////////////////////////////////////////////////////////////////////
00147  * API
00148  */
00149 
00155 PANTHEIOS_CALL(void) pantheios_be_COMErrorObject_getDefaultAppInit(
00156     pan_be_COMErrorObject_init_t* init
00157 ) /* throw() */;
00158 
00162 PANTHEIOS_CALL(int) pantheios_be_COMErrorObject_init(
00163     PAN_CHAR_T const*                   processIdentity
00164 ,   int                                 id
00165 ,   pan_be_COMErrorObject_init_t const* init
00166 ,   void*                               reserved
00167 ,   void**                              ptoken
00168 );
00169 
00173 PANTHEIOS_CALL(void) pantheios_be_COMErrorObject_uninit(
00174     void* token
00175 );
00176 
00180 PANTHEIOS_CALL(int) pantheios_be_COMErrorObject_logEntry(
00181     void*               feToken
00182 ,   void*               beToken
00183 ,   int                 severity
00184 ,   PAN_CHAR_T const*   entry
00185 ,   size_t              cchEntry
00186 );
00187 
00213 PANTHEIOS_CALL(int) pantheios_be_COMErrorObject_parseArgs(
00214     size_t                          numArgs
00215 #ifdef PANTHEIOS_NO_NAMESPACE
00216 ,   struct pan_slice_t* const       args
00217 #else /* ? PANTHEIOS_NO_NAMESPACE */
00218 ,   pantheios::pan_slice_t* const   args
00219 #endif /* PANTHEIOS_NO_NAMESPACE */
00220 ,   pan_be_COMErrorObject_init_t*   init
00221 );
00222 
00223 
00224 /* ////////////////////////////////////////////////////////////////////// */
00225 
00226 #ifdef __cplusplus
00227 # ifndef PANTHEIOS_BE_INIT_NO_CPP_STRUCT_INIT
00228 inline pan_be_COMErrorObject_init_t::pan_be_COMErrorObject_init_t()
00229 {
00230     pantheios_be_COMErrorObject_getDefaultAppInit(this);
00231 }
00232 # endif /* !PANTHEIOS_BE_INIT_NO_CPP_STRUCT_INIT */
00233 #endif /* __cplusplus */
00234 
00235 /* ////////////////////////////////////////////////////////////////////// */
00236 
00237 #endif /* PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_COMERROROBJECT */
00238 
00239 /* ///////////////////////////// end of file //////////////////////////// */

pantheios Library documentation Matthew Wilson & Synesis Software, 2006-2011 SourceForge.net Logo