Doc/Obsolete/FEEL.txt

   1 ----------------------------------------------------------------------------
   2
   3                Fatal Error Exception Library (FEEL) documentation
   4
   5 ----------------------------------------------------------------------------
   6
   7 Overview:
   8 ---------
   9
  10 A project-independent error handling interface, which acts as a base for
  11 development environment and handles all exceptions and abortion/termination
  12 calls generated by other projects.
  13
  14 Classes:
  15 --------
  16
  17 globalerrorhandler (error.h)
  18 ----------------------------
  19
  20 All errorhandling routines are gathered here as static members. Also
  21 holds some backup routines which are installed when the program exits.
  22 Win32 variant has also a backup copy of the window handle.
  23
  24 Functions:
  25
  26 Install()
  27
  28         Installs the class. Normally this is called automatically
  29         when the program starts, in main() or WinMain().
  30
  31 DeInstall()
  32
  33         Deinstalls the error handler. Normally called automatically
  34         when the program closes, in exit().
  35
  36 Abort(const char* Format, ...)
  37
  38         Generates an error message using Format and other arguments
  39         as printf() does, prints the message with a method most suitable
  40         for the current OS and terminates the program. This is a rather
  41         common function to be called, so a macro named ABORT is provided
  42         to ensure convenient using.
  43
  44         Example of usage:
  45
  46         ABORT("Fatal Error: Detected a %d-eyed Enner Beast!", 3);
  47
  48         Result: Program closes and a messagebox with text "Fatal Error:
  49         Detected a 3-eyed Enner Beast!" is displayed.
  50
  51 SetWindow(HWND* NewhWnd)
  52
  53         Win32 only. Replaces the current window handle with NewhWnd.
  54
  55 Globals:
  56 --------
  57
  58 int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR
  59                    lpCmdLine, int nCmdShow)
  60
  61         Win32 only. The starting procedure of the program. Not to be
  62         called from anywhere else.
  63
  64 ----------------------------------------------------------------------------
  65
  66 End of document.