home *** CD-ROM | disk | FTP | other *** search
/ Borland Programmer's Resource / Borland_Programmers_Resource_CD_1995.iso / utils / snoopy13 / snoopy.doc next >
Text File  |  1995-05-18  |  4KB  |  116 lines
  1.  
  2.                      Snoopy Version 1.3
  3.                   Release date: 17.11.1994
  4.                    (C)1994  by Heiko Boch
  5.  
  6.  
  7. I. Snoopy - what it is
  8. Windows has build-in debugging functions, even the retail
  9. version has them. Windows API functions send parameter error
  10. messages when they are called with wrong arguments (for example
  11. an invalid window handle).
  12. Snoopy is a program that stays in background, while "snooping"
  13. for such events. It will record errors, parameter errors and
  14. debug output. Additionally it records exit codes of ending
  15. tasks.
  16.  
  17.  
  18. II. What you need to run Snoopy
  19. Snoopy is a debug monitor for Windows 3.1 - so what will you
  20. need? At least, you will need a 386 or better (but who runs
  21. Windows on a smaller system...)
  22.  
  23.  
  24. III. How to install Snoopy
  25. Copy Snoopy into any directory and run it when ever you need it.
  26. You may want to put it into the Autostart group.
  27. If you run Snoopy as an icon it will become rainy, when an error
  28. or debug output occurs.
  29. If you want to log the Snoopy session into a file, you can put
  30. the following entry into your WIN.INI file:
  31.  
  32. [Snoopy]
  33. logfile=c:\windows\snoopy.log
  34.  
  35. Of course you can choose any valid filename.
  36. By default, Snoopy traps OutputDebugString() attempts to write
  37. to device AUX, since these cause error messages on normal
  38. Windows systems. If you have installed other debug tools, you
  39. might want Snoopy to pass output to AUX. In that case, add the
  40. entry trapDebugOutput=0 to the [Snoopy] section in your WIN.INI
  41. file.
  42.  
  43.  
  44. IV. Additional WIN.INI entries
  45. You can disable one ore more types of messages with entries in
  46. your WIN.INI file:
  47.   showOutStr=0          -> disables debug output
  48.   showLogError=0        -> disables error output
  49.   showLogParamError=0   -> disables parameter error output
  50.   showStartTask=0       -> disables start task messages
  51.   showExitTask=0        -> disables exit task messages
  52.   showDelModule=0       -> disables delete module messages
  53.   showStartDll=0        -> disables start dll messages
  54.  
  55.  
  56. V. Disclaimer
  57. THIS SOFTWARE IS PROVIDED "AS IS". THERE IS NO WARRANTY, WETHER
  58. EXPRESS NOR IMPLIED. THE AUTHOR DOES NOT ACCEPT ANY LIABILITIES
  59. WITH RESPECT TO THIS PROGRAM. USE THIS PROGRAM ON YOUR OWN RISK!
  60.  
  61. Originally, I wrote Snoopy for my own purposes. But since it has
  62. provided help to somebody else, I decided to make it public
  63. available. I do not know if it works with Windows for Workgroups
  64. or Windows NT.
  65.  
  66.  
  67. VI. Copyright
  68. You are allowed to use this version of Snoopy for free.
  69. You may distribute the program to others as long as you do not
  70. charge any fee and as long as there are no changes made with
  71. the program and this document.
  72. You may not include this program with a commercial product
  73. without a written permission of the author.
  74.  
  75.  
  76. VII. Contacting the author
  77. Feel free to send me any comments about Snoopy. But please, don't
  78. ask me about the meaning of error messages or how to remove their
  79. reasons.
  80.  
  81. Write to: Heiko Boch
  82.           Alter Schulweg 5
  83.           35579 Wetzlar
  84.           Germany
  85.  
  86. Internet: boch@rbg.informatik.th-darmstadt.de
  87.  
  88.  
  89. VIII. A word about the recorded errors
  90. Snoopy will associate every error with a loaded program module.
  91. there might be problems:
  92.         1.) The error might occur in a DLL, the program uses.
  93.             In that case, the program module name is shown, not
  94.             the name of the DLL.
  95.         2.) A program may have registered some type of hook
  96.             procedure and produces an error while processing an
  97.             hook call. In that case Snoopy records the name of
  98.             the actual module. This might be the erroneous
  99.             program or not.
  100.  
  101.  
  102. IX. Debug functions in Windows 3.1 retail version
  103.   void OutputDebugString(LPCSTR);  
  104.   void LogError(UINT err, void FAR* lpInfo);
  105.   void LogParamError(UINT err, FARPROC lpfn, void FAR* param); 
  106.   void DebugBreak(void);
  107.  
  108.  
  109. X. Trademarks - just to keep lawyers happy
  110. Windows is trademark of Microsoft Corp. (You already knew that?)
  111. The name "Snoopy" and the associated beagle may or may not be
  112. trademark of any comic publisher. This program is called so,
  113. because it snoops for debug information and you know, every
  114. Windows program needs it's own icon ;-)
  115.  
  116.