home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 18 REXX / 18-REXX.zip / rxset211.zip / ReadMe.TXT < prev    next >
Text File  |  1995-12-03  |  12KB  |  301 lines
  1.   RxFnSet package                                               Version 2.11
  2.  
  3.   By Leshek Fiedorowicz  (74170.2007@compuserve.com)      
  4.   For the latest version/news: 
  5.         http://ourworld.compuserve.com/homepages/leshek/
  6.  
  7.   File name RxSet21.ZIP - Makes all previous versions obsolete.
  8.  
  9.   This is shareware - registration: $10 after 2 weeks ( for all 2.x releases )
  10.   Fully functional, no expiration.
  11.  
  12.   SOURCE CODE available to registered users by e-mail (uuencoded zip file).
  13.   Please no changes, tampering or trespassing.
  14.   Can be distributed if unchanged.
  15.  
  16. =================================================================================
  17.  
  18.   V2.11 Dec 3, 1995 
  19.  
  20.   Fixed memory leak in RxQPRocesses.
  21.  
  22. =================================================================================
  23.  
  24.   V2.1  Nov 13, 1995 (32 bit only)
  25.  
  26.   This is Rexx callable 32 bit DLL with the following functions:
  27.  
  28.      RxSetFH           - to set new number of File Handles for process 
  29.      RxAddFH           - to add number of FH to the set already available 
  30.      RxTaskList        - for information on active tasks and theirs PIDs (Switch List)
  31.      RxQPRocesses      - for information on all active processes 
  32.                          (pid, parent pid, module name, full module name)
  33.      RxKillProcess     - for killing OS/2 process by PID
  34.      RxQueryFileSystem - for information on file system for drive
  35.      RxWildCard        - for editing text with wildcard 
  36.  
  37. =================================================================================
  38.   History:
  39.  
  40.   V2.11 Fixed memory leak in RxQPRocesses
  41.   V2.1  Released Nov 14, 1995 
  42.         By G. Lovisek (thanks) suggestion RxQProcesses function has been added.
  43.         Implemented using IBM undocumentation on undocumented DosQProcsStatus API.
  44.   V2.0  Released Nov  5, 1995 
  45.  
  46.   Credits:
  47.         G. Lovisek - prompted me to add RxQProcesses function and suggested the 
  48.                      output data format
  49.         Greg Czaja - made ColoradOS/2'95 materials available to me what helped
  50.                      to figure out the DosQProcsStatus API.
  51.  
  52. =================================================================================
  53. In this file:
  54.  
  55.   Disclaimer
  56.   Registration Info
  57.   Support
  58.   Installation
  59.   Files included
  60.   Description of provided functions
  61.  
  62. =================================================================================
  63.  
  64.   DISCLAIMER:  
  65.     Package is provided "as is", use it on your own risk. 
  66.     I will not be responsible for any damage direct or indirect (except up to 
  67.     a registration fee, once per user, for the registered users).
  68.     
  69. =================================================================================
  70.  
  71.   If you find it useful please register within 2 weeks by sending $10 to
  72.  
  73.      Leshek Fiedorowicz
  74.      3600 Brookgreen Cir. 
  75.      Lexington, KY 40509-1951
  76.  
  77. =================================================================================
  78.  
  79.   SUPPORT:
  80.  
  81.   E-mail at 74170.2007@compuserve.com is always welcome (un- and registered users)
  82.  
  83.     Unregistered users -  I will help on the best effort basis
  84.     Registered users   -  e-mail and 24h phone support 
  85.  
  86.   NOTES:
  87.      I still have a copy of RxFnSet 1.4 version for 16 and 32 bit OS/2.
  88.      Available by request for registered users.
  89.  
  90.   INSTALLATION:
  91.      Put RXFH32.DLL into a directory in your LIBPATH.                            
  92.                                                                                 
  93.   FILES INCLUDED:
  94.       RXFN32   DLL  -  Put this in your LIBPATH 
  95.       RXFNSET  DOC  -  You are reading it now
  96.       RXTLST   CMD  -  example of RxTaskList
  97.       RXKILL   CMD  -  example of RxKillProcess
  98.       RXADDFH  CMD  -  example of RXADDFH, useful for command line FH change
  99.       RXSFH    CMD  -  example of RxSetFH, useful for command line FH change
  100.       RXQFS    CMD  -  example of RxQueryFileSystem
  101.       RXWCRD   CMD  -  example of RxWildCard editing
  102.  
  103.  
  104. =================================================================================
  105.  
  106.   DESCRIPTION of FUNCTIONS INCLUDED:
  107.  
  108.                                                                                 
  109.  --  RxSetFH - will change number of available File Handles for 
  110.                Process. 
  111.         
  112.              PARAMETERS ACCEPTED:
  113.                - Number of requested file handles
  114.  
  115.              USAGE:
  116.  
  117.                   Call RxSetFH Number
  118.                or rc = RxSetFH(Number)
  119.                   /* remember to check result */
  120.                where:
  121.                Number - Number of requested file handles
  122.  
  123.              OTHER INFO:                                                                   
  124.                - Please notice that error will be returned 
  125.                  if number of requested file handles is less than 
  126.                  currently available
  127.  
  128.              RETURNS:
  129.                0  - operation successfully completed             
  130.                8  - Not Enough memory                          
  131.                87 - Invalid parameter                           
  132.                                                                 
  133.                                                                                 
  134.  
  135.   -- RxAddFH - will increase number of available File Handles 
  136.         
  137.                PARAMETERS ACCEPTED:
  138.                - Number of File Handles to add
  139.  
  140.                USAGE:
  141.  
  142.                   Call RxAddFH Number
  143.                or rc = RxAddFH(Number)
  144.                   /* remember to check result */
  145.                where:
  146.                Number - Number of requested file handles
  147.                                                                                 
  148.              OTHER INFO:                                                                   
  149.                - RXADDFH called with parameter 0 (zero) will return 
  150.                  number of currently allocated FH.  See RXADDFH.CMD 
  151.                  for use example.
  152.  
  153.              RETURNS:
  154.                - Number of allocated File Handles, that is the total
  155.                  number after adding what was requested, or maximum what 
  156.                  was able to allocate.  
  157.                  0 - if there was parameter error.
  158.                                                                                 
  159.  
  160.  
  161.  
  162.  --  RxTaskList - will return a list of tasks active in the system and their 
  163.                PIDs.  Uses WinQuerySwitchList, and works for non PM as well
  164.                as for PM. This is the same as system "Window List".
  165.         
  166.                PARAMETERS ACCEPTED:
  167.                - None
  168.  
  169.                USAGE:
  170.  
  171.                   Call RxFuncAdd ....
  172.                   Result = RxTaskList()
  173.  
  174.              RETURNS:
  175.                - PID.   - stem - where PID.0 - number of processes (elements)
  176.                                     PID.1 - PID of name in ENTRY.1 
  177.                                     ................................
  178.                - ENTRY. - stem - where ENTRY.0 - number of processes (elems.)
  179.                                     ENTRY.1 - Name of main program (PID.1)
  180.                                     ................................
  181.                - Result - is the number of returned entries (same as PID.0
  182.                           end ENTRY.0)
  183.  
  184.  --  RxQProcesses - will return a list of all processes active in the system 
  185.                with their PIDs, the PIDs of parent processes, module manes and
  186.                full qualified module names. Uses undocumented OS/2 API DosQProcsStatus.
  187.  
  188.                PARAMETERS ACCEPTED:
  189.                - None
  190.  
  191.                USAGE:
  192.  
  193.                   Call RxFuncAdd ....
  194.                   Result = RxQProcesses()
  195.  
  196.              RETURNS:
  197.                - PID.   - stem - where PID.0 - number of processes (elements)
  198.                                        PID.i - process id 
  199.                - PPID.  - stem - where PPID.0 - number of processes (elements)
  200.                                        PPID.i - parent process id 
  201.                - NAME.  - stem - where NAME.0 - number of processes (elems.)
  202.                                        NAME.i - module name (ex. CMD.EXE)
  203.                - FULLNAME.  - stem - where FULLNAME.0 - number of processes (elems.)
  204.                                        FULLNAME.i - fully qualified module name 
  205.                                        (ex. C:\OS2\CMD.EXE)
  206.                - Result - is the number of returned entries (same as PID.0
  207.                           end ENTRY.0)
  208.  
  209.   -- RxKillProcess - is a REXX external function (written in C) which 
  210.                will kill OS/2 proces of given decimal PID (Process ID)
  211.         
  212.                PARAMETERS ACCEPTED:
  213.                - PID number in decimal
  214.  
  215.                USAGE:
  216.  
  217.                   Call RxFuncAdd ....
  218.                   Call RxKillProcess(Pid)
  219.                or rc = RxKillProcess(Pid)
  220.                   /* remember to check result */
  221.                where:
  222.                Pid - PID of process to kill
  223.                                                                                 
  224.              OTHER INFO:                                                                   
  225.                - be careful
  226.  
  227.              RETURNS:
  228.                - Return code from CP call DosKillProcess:
  229.  
  230.                          - 0  - operation successfully completed             */
  231.                            13 - ERROR_INVALID_DATA                          */
  232.                            303- ERROR_INVALID_PROCID                        */
  233.                            305- ERROR_NOT_DESCENDANT                        */
  234.                                                                             */
  235.  
  236.  
  237.   -- RxQueryFileSystem - is a REXX external function (written in C) which 
  238.                will return file system name (FAT, HPFS, CDFS ... )
  239.                It uses DosQueryFSAttach CP call.
  240.         
  241.                PARAMETERS ACCEPTED:
  242.                - Drive   - in form of D: (drive letter followed by a colon).
  243.  
  244.                USAGE:
  245.  
  246.                   Call RxFuncAdd ....
  247.                   Result = RxQueryFileSystem("D:");
  248.                   
  249.                   Result - Name of File System attached to the specified drive.
  250.  
  251.              RETURNS:
  252.                - File System Name (FAT, HPFS, CDFS ..... )
  253.  
  254.  
  255.  --  RxWildCard - is a REXX external function (written in C) which 
  256.                will edit text with wildcard to help you match, edit
  257.                or audit text.  It uses DosEditName CP
  258.                call, so it accept full wildcard specification with
  259.                multi level <.> (dots), <*> and <?>.  
  260.         
  261.                PARAMETERS ACCEPTED:
  262.                - Source   - your text to be edited
  263.                - WildCard - Wild Card specification
  264.  
  265.                USAGE:
  266.  
  267.                   Call RxFuncAdd ....
  268.                   Result = RxWildCard(Source, WildCard)
  269.                   Where                                                              
  270.                   Source   - your name to be edited
  271.                   WildCard - Wild Card specification
  272.                   Result   - Source Edited with WildCard
  273.  
  274.              OTHER INFO:                                                                   
  275.                - it can be used to check if specified name matches wildcard
  276.                  (or opposite) by comparing Result with Source.  If they are
  277.                  the same after editing - match is true.  Purpose for writing
  278.                  this function first time was for text matching not just file 
  279.                  names.
  280.  
  281.              RETURNS:
  282.                - Source Edited with WildCard
  283.  
  284.  
  285. Leshek Fiedorowicz 
  286. 74170.2007@compuserve.com
  287. http://ourworld.compuserve.com/homepages/leshek/
  288.  
  289.  
  290. --------------- FILE_ID.DIZ ----------------
  291. RxFnSet v.2.11 REXX OS/2 FH TASK PROCESS FS 
  292. This is OS/2 Rexx callable 32 bit DLL with 
  293. functions to manage processes (list, kill), 
  294. number of file handles, switch list, query 
  295. file system type, mask/convert text with the 
  296. wildcard.
  297. Author: Leshek Fiedorowicz       Dec.3 1995
  298. 74170.2007@compuserve.com or point your WWW 
  299. browser for the latest version to http://
  300. ourworld.compuserve.com/homepages/leshek/
  301.