home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / comms / misc / rf911215.lha / rexxflow.doc < prev    next >
Encoding:
Text File  |  1991-11-10  |  2.1 KB  |  77 lines
  1.  
  2. OK Russ, here it is: rexxflow.library.
  3.  
  4. Copyright (C) 1991 David Jones.
  5. Use of this software is governed by the terms and conditions of the
  6. GNU General Public License.  In particular, there is NO WARRANTY.
  7.  
  8.  
  9. To install, copy the rexxflow.library binary into LIBS:.
  10.  
  11. In an ARexx script, you must first tell ARexx how to access flow.library:
  12.  
  13. call addlib("rexxflow.library", 0, -30, 0)
  14.  
  15.  
  16. One this is done, you will enjoy access to flow.library using the standard
  17. C interface with the following exceptions:
  18.  
  19. You can't "void" functions.  If you don't want the return value of a
  20. function (if there even is one), then you must use the "call" command.
  21.  
  22. wrong: SetDefaultAddress(site)
  23. right: call SetDefaultAddress(site)
  24.  
  25. Functions that return values do so normally:
  26.  
  27. detail = FindDetail(site)
  28.  
  29.  
  30. Site structures are represented by stem variables.  Set up a variable of
  31. the form:
  32.  
  33. aSite.domain
  34. aSite.zone
  35. aSite.net
  36. aSite.node
  37. aSite.point
  38.  
  39. All fields are numbers except for domain, which is a string.  Now, to pass
  40. a site to flow.library, use the name of the stem variable (aSite).  Ex:
  41.  
  42. call SetDefaultAddress(aSite)
  43.  
  44. The GetDefaultAddress function should return a site, but ARexx can't
  45. do this.  Instead, the calling syntax for GetDefaultAddress is the same
  46. as for SetDefaultAddress.  Only this time, the name of the variable
  47. is a reference to the site structure which will be filled in by the call.
  48.  
  49.  
  50. Work details and work detail nodes are returned as "cookies".  You are
  51. not meant to play with them, but a cookie returned by rexxflow can be
  52. passed back in to rexxflow with the expected results.
  53.  
  54.  
  55. There is one extra function: ScanDetail.  It goes like this:
  56.  
  57. call ScanDetail(detail, variable)
  58.  
  59. where detail is a cookie returned by some other function.  Variable is
  60. a reference to a structure that is built like this:
  61.  
  62. variable.numnodes = (number of files in work_detail)
  63. variable.n.filename
  64. variable.n.asname
  65. variable.n.flags
  66. variable.n.cost
  67.  
  68. In each case, n is a number.  This thing is really an array.
  69.  
  70.  
  71. To write stuff back, use AddWorkName and ChangeDetailPri.
  72.  
  73.  
  74. There's bound to be bugs; tell me about them.
  75.  
  76. Enjoy!
  77.