home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 171.lha / SupLib / summary.doc < prev    next >
Encoding:
Text File  |  1988-04-28  |  2.8 KB  |  87 lines
  1.  
  2. SUMMARY.DOC    Summary of library functions
  3.  
  4.  
  5.             -------- ASYNCHRONOUS FILE SUPPORT --------
  6.  
  7.  
  8.     xfi =   xfopen(file, mode, bytes)       mode: r-read w-write w+-append
  9.     err =   xfclose(xfi)
  10.      n    =   xfread(xfi, buf, n)             0 on EOF/error
  11.      n    =   xfgets(xfi, buf, max)           -1 on EOF/error else string length
  12.     err =   xfwrite(xfi, buf, n)
  13.  
  14.         bmov(src,dest,bytes)
  15.         bcmp(src,dest,bytes)
  16.         bset(src, bytes, c)
  17.         bzero(src, bytes)
  18.  
  19.         checkbreak()
  20.         resetbreak()
  21.         disablebreak()      (not available as a run-time library call)
  22.         enablebreak()       (not available as a run-time library call)
  23.  
  24.         openlibs(flags)
  25.         closelibs(flags)
  26.         closelibs(-1)       close all libraries openned w/ openlibs()
  27.  
  28.      bool = wildcmp(wildstr, namestr)
  29.  
  30.         mountrequest(bool)
  31.  
  32.         fhprintf(fh, ctrlstr, args...)
  33.  
  34.         llink(list, en)         (OBSOLETE)
  35.         lunlink(en)             (OBSOLETE)
  36.  
  37.                 SYSTEM SUPPORT
  38.  
  39.      port = CreateUniquePort(name, priority)    create port w/unique name
  40.         DeleteUniquePort(port)              delete port w/unique name
  41.         PutSyncMsg(port, msg)               normal synchronous message
  42.         PutSyncMsgSimple(port, ptr, cmd)    simple synchronous message
  43.    retcmd = WaitMsg(msg)                        wait for message to come back
  44.         CheckMsg(msg)                       check if message has come back
  45.         GetHead(list)
  46.         GetTail(list)
  47.         NextNode(node)
  48.  
  49.                   IO SUPPORT
  50.  
  51.       dfd = dio_open(name, unit, flags, req/NULL)
  52.         dio_close(dfd)
  53.         dio_closegrp(dfd)
  54.         dio_cact(dfd,bool)
  55.         dio_dup(dfd)
  56.       sig = dio_signal(dfd)
  57.       req = dio_ctl_to(dfd, command, buf, len, to)
  58.       req = dio_ctl(dfd, command, buf, len)
  59.       bool= dio_isdone(dfd)
  60.       req = dio_wait(dfd)
  61.       req = dio_abort(dfd)
  62.  
  63.         also a large array of macros are available.  if command < 0, then
  64.         asyncronous execution is implied.  Macros:
  65.  
  66.                         SYCHRONOUS        ASYNCHRONOUS
  67.  
  68.         dio_simple(dfd,com)             0=ERROR, 1=OK   undefined
  69.         dio_actual(dfd,com)             io_Actual       undefined
  70.         dio_reset(dfd)                  0=ERROR, 1=OK   n/a
  71.         dio_update(dfd)                 0=ERROR, 1=OK   n/a
  72.         dio_clear(dfd)                  0=ERROR, 1=OK   n/a
  73.         dio_stop(dfd)                   0=ERROR, 1=OK   n/a
  74.         dio_start(dfd)                  0=ERROR, 1=OK   n/a
  75.         dio_flush(dfd)                  0=ERROR, 1=OK   n/a
  76.         dio_getreq(dfd)                 returns a ptr to the IO request structure
  77.         dio_read(dfd,buf,len)           returns actual bytes read
  78.         dio_write(dfd,buf,len)          returns actual bytes written
  79.  
  80.         dio_readto(dfd,buf,len,to)      returns actual bytes read
  81.         dio_writeto(dfd,buf,len,to)     returns actual bytes written
  82.  
  83.         dio_reada(dfd,buf,len)          begin asyncronous read
  84.         dio_writea(dfd,buf,len)         begin asyncronous write
  85.  
  86.  
  87.