OTF_Errno.h 1.14 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
/*
 This is part of the OTF library. Copyright by ZIH, TU Dresden 2005-2010.
 Authors: Andreas Knuepfer, Holger Brunst, Ronny Brendel, Thomas Kriebitzsch
*/

/** 
 *  @file OTF_Errno.h
 *
 *  @brief Provides two variables that contain information about the
 *  last error that occurred.
 *
 *  You can check the error variables after every otf functions call
 *  to find out if there was an error or not.
 *  
 *  <B>Variables:</B> <BR>
 *
 *  \code
 *  int   otf_errno   -  indicates whether an error occurred or not,
 *                       values can be OTF_NO_ERROR or OTF_ERROR
 *
 *  char* otf_strerr  -  contains the last error message with a
 *                       maximum length of OTF_ERR_LEN
 *  \endcode
 *
 *
 *  Both variables can be used after including otf.h
 * \ingroup misc
 */


#ifndef OTF_ERRNO_H
#define OTF_ERRNO_H


#include <stdio.h>
#include <stdarg.h>


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/** @cond Errno.h */

/** the following line is ignored by doxygen */

void OTF_fprintf( FILE* stream, const char* format, ... );

/** @endcond */

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* OTF_ERRNO_H */