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

pantheios/backends/bec.WindowsEventLog.h

Go to the documentation of this file.
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:     26th December 2010
00008  *
00009  * Home:        http://www.pantheios.org/
00010  *
00011  * Copyright (c) 2006-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_WINDOWSEVENTLOG
00048 #define PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_WINDOWSEVENTLOG
00049 
00050 /* /////////////////////////////////////////////////////////////////////////
00051  * Version information
00052  */
00053 
00054 #ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
00055 # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_WINDOWSEVENTLOG_MAJOR       1
00056 # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_WINDOWSEVENTLOG_MINOR       2
00057 # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_WINDOWSEVENTLOG_REVISION    2
00058 # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_WINDOWSEVENTLOG_EDIT        27
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  * Application-defined Functions
00083  */
00084 
00085 #ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
00086 
00087 struct Pantheios_be_WindowsEventLog_no_longer_uses_the_symbol_BE_WINDOWSEVENTLOG_EVENTID_it_now_uses_the_function_pantheios_be_WindowsEventLog_calcCategoryAndEventId_;
00088 # define BE_WINDOWSEVENTLOG_EVENTID Pantheios_be_WindowsEventLog_no_longer_uses_the_symbol_BE_WINDOWSEVENTLOG_EVENTID_it_now_uses_the_function_pantheios_be_WindowsEventLog_calcCategoryAndEventId_()
00089 
00090 struct Pantheios_be_WindowsEventLog_no_longer_uses_the_symbol_pantheios_be_WindowsEventLog_calcCategory_it_now_uses_the_function_pantheios_be_WindowsEventLog_calcCategoryAndEventId_;
00091 # define pantheios_be_WindowsEventLog_calcCategory  struct Pantheios_be_WindowsEventLog_no_longer_uses_the_symbol_pantheios_be_WindowsEventLog_calcCategory_it_now_uses_the_function_pantheios_be_WindowsEventLog_calcCategoryAndEventId_
00092 
00093 struct Pantheios_be_WindowsEventLog_no_longer_uses_the_symbol_pantheios_be_WindowsEventLog_calcEventId_it_now_uses_the_function_pantheios_be_WindowsEventLog_calcCategoryAndEventId_;
00094 # define pantheios_be_WindowsEventLog_calcEventId struct Pantheios_be_WindowsEventLog_no_longer_uses_the_symbol_pantheios_be_WindowsEventLog_calcEventId_it_now_uses_the_function_pantheios_be_WindowsEventLog_calcCategoryAndEventId_
00095 
00096 #endif /* !PANTHEIOS_DOCUMENTATION_SKIP_SECTION */
00097 
00098 
00106 PANTHEIOS_CALL(void) pantheios_be_WindowsEventLog_calcCategoryAndEventId(
00107     int                     backEndId
00108 ,   int                     severity
00109 #if !defined(PANTHEIOS_NO_NAMESPACE)
00110 ,   pantheios::uint16_t*    category
00111 ,   pantheios::uint32_t*    eventId
00112 #else /* ? !PANTHEIOS_NO_NAMESPACE */
00113 ,   pan_uint16_t*           category
00114 ,   pan_uint32_t*           eventId
00115 #endif /* !PANTHEIOS_NO_NAMESPACE */
00116 ) /* throw() */;
00117 
00118 /* /////////////////////////////////////////////////////////////////////////
00119  * API
00120  */
00121 
00126 PANTHEIOS_CALL(int) pantheios_be_WindowsEventLog_init(
00127     PAN_CHAR_T const*   processIdentity
00128 ,   int                 id
00129 ,   void*               unused
00130 ,   void*               reserved
00131 ,   void**              ptoken
00132 );
00133 
00137 PANTHEIOS_CALL(void) pantheios_be_WindowsEventLog_uninit(
00138     void* token
00139 );
00140 
00144 PANTHEIOS_CALL(int) pantheios_be_WindowsEventLog_logEntry(
00145     void*               feToken
00146 ,   void*               beToken
00147 ,   int                 severity
00148 ,   PAN_CHAR_T const*   entry
00149 ,   size_t              cchEntry
00150 );
00151 
00152 
00153 #if 0
00154 
00155 /* TODO: Implement these in 1.0.1 beta 162+
00156  */
00157 
00160 PANTHEIOS_CALL(void) pantheios_be_WindowsEventLog_getPantheiosDotComCategoryAndEventId(
00161         int                     backEndId
00162     ,   int                     severity
00163 #if !defined(PANTHEIOS_NO_NAMESPACE)
00164     ,   pantheios::uint16_t*    category
00165     ,   pantheios::uint32_t*    eventId
00166 #else /* ? !PANTHEIOS_NO_NAMESPACE */
00167     ,   pan_uint16_t*           category
00168     ,   pan_uint32_t*           eventId
00169 #endif /* !PANTHEIOS_NO_NAMESPACE */
00170 ) /* throw() */;
00171 
00174 PANTHEIOS_CALL(int) pantheios_be_WindowsEventLog_registerEventSourceUsingPantheiosDotCom(PAN_CHAR_T const* sourceName, PAN_CHAR_T const* pantheiosDotComPath);
00175 
00178 PANTHEIOS_CALL(int) pantheios_be_WindowsEventLog_unregisterEventSourceUsingPantheiosDotCom(PAN_CHAR_T const* sourceName, PAN_CHAR_T const* pantheiosDotComPath);
00179 
00180 #endif /* 0 */
00181 
00182 /* ////////////////////////////////////////////////////////////////////// */
00183 
00184 #endif /* PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_WINDOWSEVENTLOG */
00185 
00186 /* ///////////////////////////// end of file //////////////////////////// */

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