include/pantheios/frontend.h

Go to the documentation of this file.
00001 /* /////////////////////////////////////////////////////////////////////////
00002  * File:        pantheios/frontend.h
00003  *
00004  * Purpose:     Pantheios front end API
00005  *
00006  * Created:     21st June 2005
00007  * Updated:     1st September 2006
00008  *
00009  * Author:      Matthew Wilson
00010  *
00011  * Home:        http://www.pantheios.org/
00012  *
00013  * Copyright:   Matthew Wilson and Synesis Software Pty Ltd, 1999-2005.
00014  *              Matthew Wilson, 2005-2006.
00015  *
00016  * Redistribution and use in source and binary forms, with or without
00017  * modification, are permitted provided that the following conditions are met:
00018  *
00019  * - Redistributions of source code must retain the above copyright notice, this
00020  *   list of conditions and the following disclaimer.
00021  * - Redistributions in binary form must reproduce the above copyright notice,
00022  *   this list of conditions and the following disclaimer in the documentation
00023  *   and/or other materials provided with the distribution.
00024  * - Neither the names of Matthew Wilson and Synesis Software nor the names of
00025  *   any contributors may be used to endorse or promote products derived from
00026  *   this software without specific prior written permission.
00027  *
00028  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00029  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00030  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00031  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00032  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00033  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00034  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00035  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00036  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00037  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00038  * POSSIBILITY OF SUCH DAMAGE.
00039  *
00040  * ////////////////////////////////////////////////////////////////////// */
00041 
00042 
00048 #ifndef PANTHEIOS_INCL_PANTHEIOS_H_FRONTEND
00049 #define PANTHEIOS_INCL_PANTHEIOS_H_FRONTEND
00050 
00051 /* /////////////////////////////////////////////////////////////////////////
00052  * Version information
00053  */
00054 
00055 #ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
00056 # define PANTHEIOS_VER_PANTHEIOS_H_FRONTEND_MAJOR       3
00057 # define PANTHEIOS_VER_PANTHEIOS_H_FRONTEND_MINOR       0
00058 # define PANTHEIOS_VER_PANTHEIOS_H_FRONTEND_REVISION    2
00059 # define PANTHEIOS_VER_PANTHEIOS_H_FRONTEND_EDIT        2
00060 #endif /* !PANTHEIOS_DOCUMENTATION_SKIP_SECTION */
00061 
00062 /* /////////////////////////////////////////////////////////////////////////
00063  * Includes
00064  */
00065 
00066 #include <pantheios/pantheios.h>
00067 
00068 /* /////////////////////////////////////////////////////////////////////////
00069  * Front-end API
00070  */
00071 
00116 PANTHEIOS_CALL(int) pantheios_fe_init(  void        *reserved
00117                                     ,   void        **ptoken);
00118 
00129 PANTHEIOS_CALL(void) pantheios_fe_uninit(void *token);
00130 
00147 PANTHEIOS_CALL(char const*) pantheios_fe_getProcessIdentity(void *token);
00148 
00178 PANTHEIOS_CALL(int) pantheios_fe_isSeverityLogged(  void        *token
00179                                                 ,   int         severity
00180                                                 ,   int         backEndId);
00181 
00184 /* ////////////////////////////////////////////////////////////////////// */
00185 
00186 #endif /* !PANTHEIOS_INCL_PANTHEIOS_H_FRONTEND */
00187 
00188 /* ////////////////////////////////////////////////////////////////////// */

pantheios Library documentation © Matthew Wilson, 2006 SourceForge.net Logo