gml_ErrorMessage.h

Go to the documentation of this file.
00001 /** @file gml_ErrorMessage.h
00002  * 
00003  *     An object that stores an error message and manages memory for it.
00004  * 
00005  *   Copyright (c) 2003 CLIPS-IMAG
00006  * 
00007  *   See the file "gml_LicenseTerms.txt" for information on usage and redistribution
00008  *   of this file, and for a DISCLAIMER OF ALL WARRANTIES.
00009  * 
00010  *   Created on November 22, 2003 (FB).
00011  */
00012 
00013 #ifndef __GML_ERRORMESSAGE__
00014 #define __GML_ERRORMESSAGE__
00015 
00016 #include "gml/base/gml_Types.h"
00017 
00018 /** 
00019  *  gml_ErrorMessageCreateIfNecessary --
00020  *
00021  *    Does nothing if <returnedError> is NULL.
00022  *    If <returnedError> is not NULL, allocates enough memory to store <message> and
00023  *    let <*returnedError> point to this memory, copies <message> into this memory.
00024  *    The caller is responsible to call "free ((void*)*returnedError)" when the
00025  *    error message is not more needed.
00026  */
00027 
00028 GML_EXTERN_C
00029 void gml_ErrorMessageCreateIfNecessary (char** returnedError, char* message);
00030 
00031 
00032 #endif