mi32/errhandler.h

Go to the documentation of this file.

#ifndef  INC_MI32_ERRHANDLER_H
#define  INC_MI32_ERRHANDLER_H

#ifndef  INC_MI32_STDDEFNS_H
#include <mi32/stddefns.h>
#endif

#ifdef MISYSTEMDLL
   #define CLASSLIBEXPORT MI_DLLCLASSEXPORT
   #define LIBEXPORT MI_DLLEXPORT
#else
   #define CLASSLIBEXPORT MI_DLLCLASSIMPORT
   #define LIBEXPORT MI_DLLIMPORT
#endif


#ifdef   __cplusplus
class MISTRING;
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
#if defined(__cplusplus)
extern "C" {
#endif
#endif

LIBEXPORT void ClearLastErr (void);

LIBEXPORT const MIUNICODE* GetErrDetails ();

#if defined(__cplusplus) 

LIBEXPORT MISTRING& GetErrString (
   );

LIBEXPORT const MIUNICODE* GetErrStrUC (
   ERRVALUE errcode,                   
   int *errlevel = 0                   
   );


LIBEXPORT const MIUNICODE* GetErrStrLine1UC (
   ERRVALUE errcode,                   
   int *errlevel = 0                   
   );

LIBEXPORT bool IsErrPosnDisabled ();

#else
#ifndef GENERATING_DOXYGEN_OUTPUT

LIBEXPORT const MIUNICODE* GetErrStrUC (
   ERRVALUE errcode,                   
   int *errlevel                       
   );

LIBEXPORT const MIUNICODE* GetErrStrLine1UC (
   ERRVALUE errcode,                   
   int *errlevel                       
   );

#endif // GENERATING_DOXYGEN_OUTPUT
#endif

LIBEXPORT ERRVALUE GetLastErrCode ();

LIBEXPORT void SetErrDetails (
   const MIUNICODE*
   );

#ifndef GENERATING_DOXYGEN_OUTPUT
LIBEXPORT int _SetErrPosn (int, const char*, int);
LIBEXPORT int _SetErrPosnC (int, const char*, int);
#endif // GENERATING_DOXYGEN_OUTPUT

#define  SetErrPosn(e)  _SetErrPosn(e,RCSID,__LINE__)

#define  SetErrPosnC(e) _SetErrPosnC(e,RCSID,__LINE__)


#define  SetErrPosnGoto(e)    { err=SetErrPosn(e); goto Error; }

#define  SetErrPosnGotoC(e)   { err=SetErrPosnC(e); goto Error; }


LIBEXPORT void SetErrPosnDisable (void);

LIBEXPORT void SetErrPosnEnable (void);

#if defined(__cplusplus)
}                       
#endif



#if defined(__cplusplus)
class ERRORPOSNDISABLE {
   public:
      ERRORPOSNDISABLE (
         ) { SetErrPosnDisable(); }
      
      ~ERRORPOSNDISABLE (
         ) { SetErrPosnEnable(); }
   };


class CLASSLIBEXPORT ERRORSTATE {
   public:
      ERRORSTATE (
         );
   
      ERRORSTATE (
         const ERRORSTATE& rhs
         );
   
      ~ERRORSTATE (
         );
   
      ERRORSTATE& operator= (
         const ERRORSTATE& rhs
         );

      void Clear (
         );

      void CopyFromThread ( 
         ) { *this = GetThreadErrStateRef(); }

      void Disable (
         );
   
      void Enable (
         );
   
      const MISTRING& GetDetails (
         ) const;

      ERRVALUE GetErrValue (
         ) const;

      const MISTRING& GetMessage (
         ) const;

      static MISTRING GetMessageFirstLine (
         int errcode
         );
         
      MISTRING& GetMessageRef (
         );

      static MISTRING GetMessageSingleLine (
         int errcode
         );
         
      MISTRING& GetPlaceHolderRef (
         );
         
      MISTRING GetReport (
         ) const;

      static ERRORSTATE& GetThreadErrStateRef (
         );

      static ERRORSTATE& GetThreadErrStateRefFast (
         );

      const MISTRING& GetTrace (
         ) const;

      bool IsDisabled (
         ) const;
      
      void SetDetails (
         const MISTRING& details
         );

      ERRVALUE SetPosn (
         ERRVALUE errcode,
         const char *rcsid,
         int line
         );
         
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class PRIV;
      PRIV* m_pPriv;
      #endif
   };

#endif

#undef LIBEXPORT
#undef CLASSLIBEXPORT

#endif   // INC_MI32_ERRHANDLER_H

---