home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 2 / DATAFILE_PDCD2.iso / utilities / _dbassist / !DBAssist / !Help < prev    next >
Text File  |  1994-08-11  |  3KB  |  125 lines
  1.  
  2. >!Help
  3.  
  4. !Help file for !DBAssist
  5.  
  6. Version 1.02 (11 Aug 1994)
  7.  
  8. ------------------------------------------------------------------------------
  9.  
  10. DBAssist is FREEWARE and is by Keith Hall.
  11.  
  12. You may freely distribute this program in its entirety with ONLY the following
  13. unaltered files:
  14.  
  15. !Boot
  16. !Help (This one)
  17. !Run
  18. !RunImage
  19. !Sprites
  20. Templates
  21.  
  22. This program is © Keith Hall 1994. You may NOT include this program or any
  23. part thereof in any commercial software without my prior written permission.
  24.                
  25. Technical details
  26. -----------------
  27.  
  28. DBAssist is a small utility program to aid debugging desktop programs.
  29.  
  30. Instead of having to use Wimp_ReportError to display variables etc. whilst
  31. debugging, or writing them to a file which possibly could be corrupted if the
  32. software crashes the machine, it should send a wimp message to DBAssist,
  33. which will then display the line in a window and optionally write it to a file
  34. also.
  35.  
  36. To use !DBassist in your programs (conversion from data types other than
  37. strings should be done in the usual way for the language concerned) :
  38.  
  39. BASIC:
  40.  
  41. DEF PROCtrace(line$)
  42. DIM msgblock% 256
  43. !msgblock%=(24+LEN(line$)) AND NOT 3
  44. msgblock%!4=0
  45. msgblock%!8=0
  46. msgblock%!12=0
  47. msgblock%!16=&82782
  48. $(msgblock%+20)=line$
  49. SYS"Wimp_SendMessage",17,msgblock%,0
  50.  
  51. C: (DeskLib)
  52.  
  53. void trace(char *line)
  54. {
  55.   message_block msg;
  56.   msg.header.size=(24+strlen(line)) & ~3;
  57.   msg.header.action=0x82782;
  58.   strcpy(msg.data.bytes,line);
  59.   Wimp_SendMessage(event_SEND,&msg,0,NULL);
  60. }
  61.  
  62. C: (Risc_OSLib)
  63.  
  64. void trace(char *line)
  65. {
  66.   wimp_msgstr msg;
  67.   msg.hdr.size=(24+strlen(line)) & ~3;
  68.   msg.hdr.action=0x82782;
  69.   strcpy(msg.data.chars,line);
  70.   wimp_sendmessage(17,&msg,0);
  71. }
  72.  
  73.  
  74. To make !DBAssist automatically use the logfile when it's loaded, change the
  75. !Run file so that the line :
  76.  
  77.    Run <DBAssist$Dir>.!RunImage %*0
  78.  
  79. becomes
  80.  
  81.    Run <DBAssist$Dir>.!RunImage -log %*0
  82.  
  83. Alternatively you can load the program with a commandline parameter of '-log'.
  84.  
  85. The format of the lines produced by DBAssist are as follows :
  86.  
  87. Date [taskname] textmessage
  88.  
  89. 'textmessage' is the textual contents of the message sent by the task wishing
  90. !DBAssist to display.
  91. '[taskname]' is the name of the task responsible for sending 'textmessage'.
  92.  
  93. Clicking left button on the iconbar icon opens the text window, right button
  94. closes it again.
  95.  
  96.  
  97. Changes to V1.01
  98.  
  99. Faster. Will now only record the time and the text message in the logfile.
  100. The task name is recorded whenever it changes, to save space and aid
  101. readability.
  102.  
  103. Changes to V1.02
  104.  
  105. Automatic dbassist logging detection provided for those programs capable
  106. of writing their own logfile, so they can switch output (e.g. Binkley).
  107.  
  108. The message is #&82782 (as above, but the first word of the data in the
  109. message being the 'action' code). Codes are:
  110.  
  111. &827820 - enquire and force DBAssist to respond if present
  112. &827821 - sent by DBAssist when starting and after receiving &827820
  113. &827822 - sent by DBAssist when shutting down.
  114.  
  115. ------------------------------------------------------------------------------
  116.  
  117. Send bug reports, useful additions, compliments etc. to me on The Plasma
  118. Sphere (#1), Arcade (#1147), or in the ARCNET echo. You can also netmail me
  119. at Fidonet#2:250/219.0
  120.  
  121. Cheers,
  122.  
  123. |/
  124. |\eith.
  125.