home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / utilities / utilsd / evntshell / Docs / StrongHelp < prev    next >
Encoding:
Text File  |  1994-04-01  |  1.7 KB  |  57 lines
  1. -----------------------------------------------------------------
  2. PROCshell_InitHelpSystem()
  3. Params =>
  4.          str  path name of help files
  5.          bool DieWithTask flag
  6.  
  7. Used to register a new help system with StrongHlp.
  8. After making this call StrongHlp will add the help
  9. system found in the given path to its icon bar menu.
  10.  
  11. If StrongHlp cannot be found then the initialisation
  12. command is stored and sent when StrongHlp is started.
  13.  
  14. -DieWithTask Flag
  15. When TRUE the help system will only be added to 
  16. the StrongHlp icon bar menu while the user 
  17. application is actually running. When FALSE it
  18. remains available when the application quits.
  19.  
  20.  
  21. -----------------------------------------------------------------
  22.  
  23. PROCshell_HelpWord()
  24. Params =>
  25.          str word for which help is to be displayed
  26.  
  27. Used to send a help request to StrongHlp. If the word
  28. is found in the help system the appropriate help text
  29. will be displayed.
  30.  
  31. StrongHlp will be started if it is not already
  32. running and StrongHelp$Dir has been defined. If
  33. StrongHlp cannot be found then an error will be
  34. generated.
  35.  
  36. -----------------------------------------------------------------
  37.  
  38. FNshell_StrongHlpIsAvailable
  39. Params =>
  40.          None
  41.        <=
  42.          bool TRUE if StrongHelp$Dir is defined,
  43.               otherwise FALSE
  44.               
  45. Used to check that StrongHlp is installed
  46. on the system. This call can be used to shade
  47. a 'Help' menu item if StrongHlp has not been seen
  48. by the Filer, or if it is not available.
  49.  
  50. Example code...
  51.  
  52. Shade menu item with the handle HlpItem% if StrongHlp
  53. is not available:
  54.  
  55. PROCshell_MenuShade(HlpItem%,(FNshell_StrongHlpIsAvailable=0))
  56.   
  57. -----------------------------------------------------------------