home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 375.lha / MRARPFile_v1.1 / MRARPFile.doc < prev    next >
Text File  |  1990-05-02  |  3KB  |  63 lines
  1.  
  2.             MRARPFile - Extended ARP File Support
  3.             Version 1.1
  4.             Mark Rinfret, 04/15/89
  5.             Public Domain
  6.  
  7. This package constitutes a non-approved (at this time) extension to the ARP
  8. (Amiga  Resource  Project) programmer's support library.  It is intended to
  9. be used with ARP version 1.3 and higher.
  10.  
  11. I  like  ARP.   I  would  like all of my utilities to take advantage of its
  12. shared  library  and  resource  tracking.   While  attempting  to convert a
  13. program  which  appeared  on the net not long ago, I realized that it would
  14. have  been  nice, had ARP provided the FGets/FPuts routines.  Sure, you can
  15. simulate  FPuts with FPrintf, but that's kludgy.  You're still left hanging
  16. in the breeze when it comes to FGets.  So, I started writing...
  17.  
  18. This   package  provides  an  orthogonal  set  of  routines  which  support
  19. generalized  I/O  with  resource  tracking (and early release, if you want)
  20. while  using  the  ARP  library.   There  are essentially 3 tracked objects
  21. associated with a file:
  22.  
  23.     - a structure describing the file
  24.     - the file itself
  25.     - an optional buffer
  26.  
  27. Access  to  files  is  gained  via  the  OpenARPFile function.  A companion
  28. routine, CloseARPFile, will release all resources associated with the file.
  29. CloseARPFile  must  be  called  if  buffered output is present since I have
  30. provided  no  tracking  mechanism  to cause the output buffer to be flushed
  31. (thanks to Chris Wichura for pointing this out).
  32.  
  33. File  buffering  is  optional,  and recommended when using the FGetsARP and
  34. FPutsARP  routines (typically used with text files).  A SeekARPFile routine
  35. allows you some freedom of access, in both input and output files, properly
  36. managing the optional buffers.
  37.  
  38. Please see the embedded documentation in the source for more usage info.  I
  39. feel  this  is  just  another  of those little hacks that anyone could have
  40. done,  but  I needed it and thus appointed myself to do it.  I hope some of
  41. you  out  there  find  it  useful.  I'd appreciate hearing any constructive
  42. comments that you might have.
  43.  
  44. What's Included?
  45.  
  46.     MRARPFile.doc   - this file
  47.     MRARPFile.h     - include file defining ARPFileHandle, routines
  48.     MRARPFile.c     - source for the MRARPFile support routines
  49.     Makefile        - rules file for the make tool
  50.     Test.c          - small test program source
  51.     Test            - small test program executable
  52.     MRARPFile.lib   - 32 bit Manx Aztec C V5.0a library
  53.     MRARPFile16.lib - 16 bit Manx Aztec C V5.0a library
  54.     functions.diff  - some changes I made to my Aztec functions.h file.
  55.     StoreTracker.asm - A derelict from an uninformed age :-). Provides an
  56.                       alternative method for obtaining the LastTracker.
  57.                       You shouldn't need it, but "it's in there".
  58.  
  59.                                             Mark Rinfret
  60.  
  61.                                             mrr@amanpt1.Newport.RI.US
  62.                                             BIX: markr
  63.