00001 /* /////////////////////////////////////////////////////////////////////////
00002  * File:        pantheios/backends/bec.WindowsEventLog.h
00003  *
00004  * Purpose:     Declaration of the Pantheios WindowsEventLog Stock Back-end API.
00005  *
00006  * Created:     8th May 2006
00007  * Updated:     10th July 2008
00008  *
00009  * Author:      Matthew Wilson
00010  *
00011  * Home:        http://www.pantheios.org/
00012  *
00013  * Copyright:   Matthew Wilson, 2005-2008.
00014  *
00015  * Redistribution and use in source and binary forms, with or without
00016  * modification, are permitted provided that the following conditions are
00017  * met:
00018  *
00019  * - Redistributions of source code must retain the above copyright notice,
00020  *   this list of conditions and the following disclaimer.
00021  * - Redistributions in binary form must reproduce the above copyright
00022  *   notice, this list of conditions and the following disclaimer in the
00023  *   documentation and/or other materials provided with the distribution.
00024  * - Neither the name(s) of Matthew Wilson and Synesis Software nor the
00025  *   names of any contributors may be used to endorse or promote products
00026  *   derived from this software without specific prior written permission.
00027  *
00028  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
00029  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
00030  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00031  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
00032  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00033  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00034  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00035  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00036  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00037  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00038  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00039  *
00040  * ////////////////////////////////////////////////////////////////////// */
00041 
00042 
00048 #ifndef PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_WINDOWSEVENTLOG
00049 #define PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_WINDOWSEVENTLOG
00050 
00051 /* /////////////////////////////////////////////////////////////////////////
00052  * Includes
00053  */
00054 
00055 #ifndef PANTHEIOS_INCL_PANTHEIOS_H_PANTHEIOS
00056 # include <pantheios/pantheios.h>
00057 #endif /* !PANTHEIOS_INCL_PANTHEIOS_H_PANTHEIOS */
00058 #ifndef PANTHEIOS_INCL_PANTHEIOS_H_BACKEND
00059 # include <pantheios/backend.h>
00060 #endif /* !PANTHEIOS_INCL_PANTHEIOS_H_BACKEND */
00061 
00062 /* /////////////////////////////////////////////////////////////////////////
00063  * Documentation
00064  */
00065 
00071 /* /////////////////////////////////////////////////////////////////////////
00072  * External Declarations
00073  */
00074 
00075 #ifdef __cplusplus
00076 extern "C"
00077 {
00078 #endif /* __cplusplus */
00079 
00087 extern unsigned             BE_WINDOWSEVENTLOG_EVENTID;
00088 
00095 PANTHEIOS_CALL(unsigned)    pantheios_be_WindowsEventLog_calcCategory(int backEndId, int severity) /* throw() */;
00096 
00097 #ifdef __cplusplus
00098 } /* extern "C" */
00099 #endif /* __cplusplus */
00100 
00101 /* /////////////////////////////////////////////////////////////////////////
00102  * API
00103  */
00104 
00109 PANTHEIOS_CALL(int) pantheios_be_WindowsEventLog_init(  char const* processIdentity
00110                                                     ,   int         id
00111                                                     ,   void*       unused
00112                                                     ,   void*       reserved
00113                                                     ,   void**      ptoken);
00114 
00118 PANTHEIOS_CALL(void) pantheios_be_WindowsEventLog_uninit(void* token);
00119 
00123 PANTHEIOS_CALL(int) pantheios_be_WindowsEventLog_logEntry(  void*       feToken
00124                                                         ,   void*       beToken
00125                                                         ,   int         severity
00126                                                         ,   char const* entry
00127                                                         ,   size_t      cchEntry);
00128 
00129 /* ////////////////////////////////////////////////////////////////////// */
00130 
00131 #endif /* PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_WINDOWSEVENTLOG */
00132 
00133 /* ////////////////////////////////////////////////////////////////////// */

pantheios Library documentation © Matthew Wilson, 2006-2008