gml_Errors.h File Reference


Detailed Description

Manages error codes and their corresponding textual description.

#include "gml/base/gml_Types.h"

Go to the source code of this file.


Typedefs

typedef short gml_TError
 The type representing errors in Gml.

Functions

GML_EXTERN_C gml_TError gml_ErrorNew (char *message)
 Register a new error message and return its code.
GML_EXTERN_C char * gml_ErrorGetMessage (gml_TError error)
 Return the message corresponding to a given error code.
GML_EXTERN_C void gml_ErrorDispose ()
 Releases all error manager resources.

Variables

static const gml_TError gml_cNoError = 0
 no error
gml_TError gml_gErrorNotImplemented
 not implemented
gml_TError gml_gErrorMemFull
 no more memory
gml_TError gml_gErrorWrongParameterVal
 parameter value not acceptable
gml_TError gml_gDivideByZero
 divide by zero of singularity
gml_TError gml_gErrorFileOpenRead
 could not open file for reading
gml_TError gml_gErrorFileOpenWrite
 could not open file for writing
gml_TError gml_gErrorFileRead
 while reading data from file
gml_TError gml_gErrorFileWrite
 while writing data to file

Function Documentation

GML_EXTERN_C gml_TError gml_ErrorNew ( char *  message  ) 

Register a new error message and return its code.

Parameters:
[in] message the error message

GML_EXTERN_C char* gml_ErrorGetMessage ( gml_TError  error  ) 

Return the message corresponding to a given error code.

Parameters:
[in] error the error code

Generated on Tue Jun 12 14:03:28 2007 for gml by Doxygen 1.5.2.