home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 18 REXX / 18-REXX.zip / rxpmpapi.zip / rxpmpapi.txt < prev    next >
Text File  |  1997-06-20  |  3KB  |  80 lines
  1. This file describes how to install and use RXPMPAPI.DLL.  See the file
  2. README.TXT for a brief description of RXPMPAPI.DLL, its cost (or lack
  3. there of), redistribution instructions, and the don't-come-after-me
  4. disclaimer.
  5.  
  6.  
  7. Installation
  8.  
  9. Put RXPMPAPI.DLL in a directory listed in your LIBPATH.
  10.  
  11.  
  12. Using RXPMPAPI.DLL
  13.  
  14. The Rexx API consists of six functions.  Four of the Rexx functions
  15. mirror the C API functions described in PMPATROL.INF in your PM Patrol
  16. directory.  See that file for detailed descriptions of those
  17. functions.  The remaining two functions, RxDCFLoadFuncs and
  18. RxDCFDropFuncs, allow quick loading/dropping of the functions into/out
  19. of the Rexx namespace.
  20.  
  21. The names of the four main Rexx functions are formed by prefixing "Rx"
  22. to the name of the corresponding C API function.  For example, the
  23. Rexx function RxDCFGetStats corresponds to the C function
  24. DCFGetStats().  If the return value from the C function is Boolean,
  25. the Rexx function returns a 0 or 1, which is the standard for Boolean
  26. values in Rexx.  If the return value from the C function is a return
  27. code, such as DCF_INACTIVE_ERROR, the Rexx function returns that code
  28. as a string, i.e. "DCF_INACTIVE_ERROR".  With the exception of
  29. DCFGetStats(), the parameters for the C API and the Rexx API are
  30. identical.
  31.  
  32.      1. RxDCFGetStats('dcfStats.' [, 'dcfpStats.'])
  33.  
  34.         Retrieves the last set of real-time statistics
  35.         collected.  The Rexx version of this function takes one or two
  36.         parameters.
  37.         
  38.         The first parameter is a stem variable in which
  39.         to place the contents of the dcfstats structure, with the
  40.         exception of the pstatTbl field.  See the file PMPAPI.H in the
  41.         PM Patrol directory for a description of the dcfstats
  42.         structure.  Each field in the C structure is a valid tail for
  43.         the stem.  For example, the upTimeSecs field in the C
  44.         structure can be accessed from the Rexx stem dcfStats. as
  45.         dcfStats.upTimeSecs.
  46.  
  47.         The second parameter is a stem variable in which to place the
  48.         pstatTbl field of the dcfstats structure.  The pstatTbl field
  49.         is an array of dcfpstats (see PMPAPI.H) structures.  If the
  50.         stem used for the second parameter in the call to
  51.         RxDCFGetStats is 'dcfpStats.', then
  52.                 dcfpStats.0 = # of elements in the array
  53.                             = # of processes running
  54.                 dcfpStats.1.pid = PID of first process
  55.                 dcfpStats.1.ppis = parent PID of first process
  56.                         ...
  57.                 dcfpStats.2.pid = PID of second process
  58.                         ...
  59.                 (etc.)
  60.  
  61.         See the file RXPMPTST.CMD for an example of using
  62.         RxDCFGetStats.
  63.  
  64.      2. RxDCFUserDefined(buffer)
  65.  
  66.         Sets the user-defined field of the PM Patrol status line to
  67.         buffer.
  68.  
  69.      3. RxDCFVerify()
  70.  
  71.         Verify the DCF is running.
  72.  
  73.      4. RxPMPShutDown()
  74.  
  75.         Shutdown PM Patrol and the DCF.
  76.  
  77.  
  78. Darren Abbott
  79. abbott@hiwaay.net
  80.