home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / epmcsamp.zip / EPMCSAMP / READ.ME < prev   
Text File  |  1995-11-10  |  3KB  |  50 lines
  1. This is a starter-kit for writing EPM macros in C.  If you unpacked
  2. EPMCSAMP.ZIP so that the directory structure was preserved, then the
  3. layout should be as follows:
  4.    epmcsamp         - This file and ETKE.INF
  5.    epmcsamp\src     - The source for the sample code
  6.    epmcsamp\include - The E Toolkit include files
  7.  
  8. EPMCSAMP.C defines the following commands.
  9. (You have to provide CSet and the OS/2 Toolkit.)
  10.  
  11.   Each     - Execute a given command against each file in the ring.
  12.   FindAll  - Find a line containing all of the given space-delim. strings
  13.   FindAllC - As above, but case-insensitive.
  14.   Expunge  - Delete all lines containing a given string.  (The string is
  15.              a Locate command argument, so can use GREP, etc.)
  16.   FindDup  - Find the next duplicated line.
  17.   QTS      - Query the timestamp of the specified or current file.
  18.   SaveOld  - Save a file and keep its timestamp unchanged.
  19.   test     - Displays the first & last line in the file, to demonstrate
  20.              the use of the EtkAccessLowLevelData call.
  21.   Highlight- Highlight a given string.  (The string is a Locate command
  22.              argument, so can use GREP, etc.)
  23.   UnHighlight-Remove all highlighting in the file matching a specified
  24.              color.  Defaults to the same color used by the Highlight
  25.              command, but the color can be passed in as an argument (so,
  26.              for example, you can "UnHighlight 244" to remove the
  27.              highlighting added by the Workframe to show compiler errors).
  28.  
  29. To execute a command, you can enter:
  30.      dyna_cmd epmcsamp FindDup
  31. or:  dyna_cmd epmcsamp FindAll this that the_other
  32. or:  dyna_cmd epmcsamp Expunge /unwanted/wc
  33.  
  34. etc.  Note that the name of the macro is case-sensitive.  (This is
  35. ideal for adding as a Toolbar item - place an asterisk ('*') in the
  36. Function field, and the 'dyna_cmd ...' in the Parameters field.)
  37.  
  38. Note:  After executing a dyna_cmd macro, the corresponding DLL will
  39. be "locked" until EPM ends.  If you're in the middle of developing
  40. it, you can use the DynaFree command to free it sooner - e.g.,
  41.    dynafree epmcsamp
  42.  
  43. This package contains the online documentation & *.H from the ETKBBBS
  44. package, version 6.  It is available separately for the benefit of those
  45. who wish to write EPM macros in C.  Those wishing to make more advanced
  46. use of the E Toolkit should get the entire package, which contains the
  47. EPM Tool-Kit, the latest documentation, updated samples, and macros.
  48.  
  49. Use VIEW (part of OS/2) to read the ETKE.INF file.
  50.