home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 18 REXX / 18-REXX.zip / rxfnset.zip / RXFNSET.DOC < prev    next >
Text File  |  1995-11-05  |  10KB  |  239 lines
  1.   RxFnSet package                                               Version 2.0
  2.  
  3.   RXFNSET 32 bit for OS/2 Version 2.x and up                                          
  4.   By Leshek Fiedorowicz  (74170.2007@compuserve.com)      
  5.  
  6.   This is shareware - registration: $10 after 2 weeks ( for all 2.x releases )
  7.   Fully functional, no expiration.
  8.  
  9.   SOURCE CODE available to registered users by e-mail (<20K zip file - uuencoded).
  10.   Please no changes, tampering or trespassing, 
  11.   can be distribute if unchanged.
  12.  
  13. =================================================================================
  14.  
  15.   V2.0  Nov 5, 1995 (32 bit only)
  16.  
  17.   This is Rexx callable 32 bit DLL with the following functions:
  18.  
  19.      RxSetFH           - to set new number of FH for process OS/2 1.x & 2.x.
  20.      RxAddFH           - to add number of FH to the set already available 
  21.      RxTaskList        - for information on active tasks and theirs PIDs
  22.      RxKillProcess     - for killing OS/2 process by PID
  23.      RxWildCard        - for editing name with wild card
  24.      RxQueryFileSystem - for information on file system for drive
  25.      RxWildCard        - for editing text with wildcard 
  26.  
  27. =================================================================================
  28. In this file:
  29.  
  30.   Disclaimer
  31.   Registration Info
  32.   Support
  33.   Installation
  34.   Files included
  35.   Description of provided functions
  36.  
  37. =================================================================================
  38.  
  39.   DISCLAIMER:  
  40.     Package is provided "as is", use it on your own risk. 
  41.     I will not be responsible for any damage direct or indirect (except up to 
  42.     a registration fee, once per user, for the registered users).
  43.     
  44. =================================================================================
  45.  
  46.   If you find it useful please register within 2 weeks by sending $10 to
  47.      Leshek Fiedorowicz
  48.      3600 Brookgreen Cir. 
  49.      Lexington, KY 40509-1951
  50.  
  51. =================================================================================
  52.  
  53.   SUPPORT:
  54.  
  55.   E-mail at 74170.2007@compuserve.com is always welcome (un- and registered users)
  56.  
  57.     Unregistered users -  I will help on the best effort basis
  58.     Registered users   -  e-mail and 24h phone support 
  59.  
  60.   NOTES:
  61.      I still have a copy of RxFnSet 1.4 version for 16 and 32 bit OS/2.
  62.      Available by request for registered users.
  63.  
  64.   INSTALLATION:
  65.      Put RXFH32.DLL into a directory in your LIBPATH.                            
  66.                                                                                 
  67.   FILES INCLUDED:
  68.       RXFN32   DLL  -  Put this in your LIBPATH 
  69.       RXFNSET  DOC  -  You are reading it now
  70.       RXTLST   CMD  -  example of RxTaskList
  71.       RXKILL   CMD  -  example of RxKillProcess
  72.       RXADDFH  CMD  -  example of RXADDFH, useful for command line FH change
  73.       RXSFH    CMD  -  example of RxSetFH, useful for command line FH change
  74.       RXQFS    CMD  -  example of RxQueryFileSystem
  75.       RXWCRD   CMD  -  example of RxWildCard editing
  76.  
  77.  
  78. =================================================================================
  79.  
  80.   DESCRIPTION of FUNCTIONS INCLUDED:
  81.  
  82.                                                                                 
  83.  --  RxSetFH - is a REXX external function (written in C) which 
  84.                will change number of available File Handles for 
  85.                Process. 
  86.         
  87.              PARAMETERS ACCEPTED:
  88.                - Number of requested file handles
  89.  
  90.              USAGE:
  91.  
  92.                   Call RxSetFH Number
  93.                or rc = RxSetFH(Number)
  94.                   /* remember to check result */
  95.                where:
  96.                Number - Number of requested file handles
  97.  
  98.              OTHER INFO:                                                                   
  99.                - Please notice that error will be returned 
  100.                  if number of requested file handles is less than 
  101.                  currently available
  102.  
  103.              RETURNS:
  104.                0  - operation successfully completed             
  105.                8  - Not Enough memory                          
  106.                87 - Invalid parameter                           
  107.                                                                 
  108.                                                                                 
  109.  
  110.   -- RxAddFH - is a REXX external function (written in C) which 
  111.                will increase number of available File Handles 
  112.         
  113.                PARAMETERS ACCEPTED:
  114.                - Number of File Handles to add
  115.  
  116.                USAGE:
  117.  
  118.                   Call RxAddFH Number
  119.                or rc = RxAddFH(Number)
  120.                   /* remember to check result */
  121.                where:
  122.                Number - Number of requested file handles
  123.                                                                                 
  124.              OTHER INFO:                                                                   
  125.                - RXADDFH called with parameter 0 (zero) will return 
  126.                  number of currently allocated FH.  See RXADDFH.CMD 
  127.                  for use example.
  128.  
  129.              RETURNS:
  130.                - Number of allocated File Handles, that is the total
  131.                  number after adding what was requested, or maximum what 
  132.                  was able to allocate.  
  133.                  0 - if there was parameter error.
  134.                                                                                 
  135.  
  136.  
  137.  
  138.  --  RxTaskList - is a REXX external function (written in C) which 
  139.                will return a list of tasks active in the system and their 
  140.                PIDs.  Uses WinQuerySwitchList, and works for non PM as well
  141.                as for PM. 
  142.         
  143.                PARAMETERS ACCEPTED:
  144.                - None
  145.  
  146.                USAGE:
  147.  
  148.                   Call RxFuncAdd ....
  149.                   Result = RxWildCard()
  150.  
  151.              RETURNS:
  152.                - PID.   - stem - where PID.0 - number of processes (elements)
  153.                                     PID.1 - PID of name in ENTRY.1 
  154.                                     ................................
  155.                - ENTRY. - stem - where ENTRY.0 - number of processes (elems.)
  156.                                     ENTRY.1 - Name of main program (PID.1)
  157.                                     ................................
  158.                - Result - is the number of returned entries (same as PID.0
  159.                           end ENTRY.0)
  160.  
  161.   -- RxKillProcess - is a REXX external function (written in C) which 
  162.                will kill OS/2 proces of given decimal PID (Process ID)
  163.         
  164.                PARAMETERS ACCEPTED:
  165.                - PID number in decimal
  166.  
  167.                USAGE:
  168.  
  169.                   Call RxFuncAdd ....
  170.                   Call RxKillProcess(Pid)
  171.                or rc = RxKillProcess(Pid)
  172.                   /* remember to check result */
  173.                where:
  174.                Pid - PID of process to kill
  175.                                                                                 
  176.              OTHER INFO:                                                                   
  177.                - be careful
  178.  
  179.              RETURNS:
  180.                - Return code from CP call DosKillProcess:
  181.  
  182.                          - 0  - operation successfully completed             */
  183.                            13 - ERROR_INVALID_DATA                          */
  184.                            303- ERROR_INVALID_PROCID                        */
  185.                            305- ERROR_NOT_DESCENDANT                        */
  186.                                                                             */
  187.  
  188.  
  189.   -- RxQueryFileSystem - is a REXX external function (written in C) which 
  190.                will return file system name (FAT, HPFS, CDFS ... )
  191.                It uses DosQueryFSAttach CP call.
  192.         
  193.                PARAMETERS ACCEPTED:
  194.                - Drive   - in form of D: (drive letter followed by a colon).
  195.  
  196.                USAGE:
  197.  
  198.                   Call RxFuncAdd ....
  199.                   Result = RxQueryFileSystem("D:");
  200.                   
  201.                   Result - Name of File System attached to the specified drive.
  202.  
  203.              RETURNS:
  204.                - File System Name (FAT, HPFS, CDFS ..... )
  205.  
  206.  
  207.  --  RxWildCard - is a REXX external function (written in C) which 
  208.                will edit text with wildcard to help you match, edit
  209.                or audit text.  It uses DosEditName CP
  210.                call, so it accept full wildcard specification with
  211.                multi level <.> (dots), <*> and <?>.  
  212.         
  213.                PARAMETERS ACCEPTED:
  214.                - Source   - your text to be edited
  215.                - WildCard - Wild Card specification
  216.  
  217.                USAGE:
  218.  
  219.                   Call RxFuncAdd ....
  220.                   Result = RxWildCard(Source, WildCard)
  221.                   Where                                                              
  222.                   Source   - your name to be edited
  223.                   WildCard - Wild Card specification
  224.                   Result   - Source Edited with WildCard
  225.  
  226.              OTHER INFO:                                                                   
  227.                - it can be used to check if specified name matches wildcard
  228.                  (or opposite) by comparing Result with Source.  If they are
  229.                  the same after editing - match is true.  Purpose for writing
  230.                  this function first time was for text matching not just file 
  231.                  names.
  232.  
  233.              RETURNS:
  234.                - Source Edited with WildCard
  235.  
  236.  
  237. Leshek Fiedorowicz 
  238.  
  239.