home *** CD-ROM | disk | FTP | other *** search
/ ftp.barnyard.co.uk / 2015.02.ftp.barnyard.co.uk.tar / ftp.barnyard.co.uk / cpm / walnut-creek-CDROM / BEEHIVE / ZSUS / Z3HELP-6.LBR / ZA.LBR / Z33LIB.HZP / Z33LIB.HLP
Text File  |  2000-06-30  |  9KB  |  279 lines
  1. ;
  2.                                  Z33LIB.LIB                                   
  3.  
  4.              Size (recs) CRC   Version    Author/Latest Issue      Disk
  5. Z33LIB.REL     2k (15)   CD14  0.5        Jay Sage 10/87           Z3LIB2
  6.  
  7.                                                                               
  8.  
  9.    Z33LIB is a collection of the module headers from the source code for the
  10. Z33LIB routines that have been written to date.
  11.  
  12.    A - FCB1CHK    I - GETER3      Q - PUTER1     Y - SCAN
  13.    B - FCB2CHK    J - GETSFCB     R - PUTER3     Z - SETEPB
  14.    C - FCBCHK     K - GETSRUN     S - PUTERC     1 - STOPXSUB
  15.    D - GCMDDU     L - GETSUB      T - PUTSUB     2 - SUBON
  16.    E - GDEFDU     M - HALTSUB     U - QERROR     3 - Z33CHK
  17.    F - GETCCP     N - HIGHUSER    V - REPARSE    4 - Z33FNAME
  18.    G - GETECP     O - PARSE2      W - RESEPB
  19.    H - GETER1     P - PDEFDU      X - RETCST
  20. :a 
  21.  
  22.  
  23.  FCB1CHK 
  24.  
  25.    This routine checks the  first  default file control block to  see  if  the
  26. token  parsed there  was  a valid  file specification.   If there was an error
  27. (signalled by  a nonzero value in the  record-count byte),  then  this routine
  28. returns NZ and register A nonzero.   A zero value and Z flag signals  a  valid
  29. FCB.
  30. :b
  31.  
  32.  
  33.  FCB2CHK 
  34.  
  35.    This routine checks the  second default file control  block to see  if  the
  36. token parsed there  was  a valid file specification.   If there  was  an error
  37. (signalled by  a nonzero value in  the record-count byte),  then  this routine
  38. returns NZ and register A nonzero.   A zero value and Z flag signals  a  valid
  39. FCB.
  40. :c
  41.  
  42.  
  43.  FCBCHK 
  44.  
  45.    This routine checks the file control block pointed to  by DE  to see  if it
  46. contains  a validly parsed file specification.   ZCPR33 sets  the record-count
  47. byte  to  a nonzero value if there was  an error  in  resolving the file spec.
  48. If the FCB is valid,  this routine returns Z and A=0.   No other registers are
  49. affected.
  50.  
  51. :d
  52.  
  53.  
  54.  GCMDDU 
  55.  
  56.    This routine examines the external commmand file control block to determine
  57. the directory (drive/user) in which  the  file  was located  during  the  path
  58. search.   The values are  returned in  the BC register pair, with the drive in
  59. B being in the range 0..15.  No other registers are affected.
  60. :e
  61.  
  62.  
  63.  GDEFDU 
  64.  
  65.    This routine  gets  the values  of the current default  (logged) drive/user 
  66. area into BC by reading the CURDR and CURUSR bytes in the message buffer.   No
  67. registers other than BC are affected.
  68. :f
  69.  
  70.  
  71.  GETCCP 
  72.  
  73.    This routine calculates the starting address of  the CCP based on  the BIOS
  74. warmboot  vector.   The result  is returned  in HL.   No  other registers  are
  75. affected.
  76. :g
  77.  
  78.  
  79.  GETECP 
  80.  
  81.    This routine  locates  the  name  of  the ECP in  the command processor and 
  82. returns its address in HL.  All other registers are preserved.
  83. :h
  84.  
  85.  
  86.  GETER1 
  87.  
  88.    This routine supercedes the  same routine in Z3LIB.   It examines the error
  89. command line  to determine if  an error command is present  or not.   If  none
  90. is present,  A=0 and the Z flag is set.   If an error command line is present,
  91. then A<>0, and NZ is returned.  No other register is affected.
  92. :i
  93.  
  94.  
  95.  GETER3 
  96.  
  97.    This routine returns the value of the command error flag in register A  and
  98. sets the flags accordingly.  No other registers are affected.
  99. :j
  100.  
  101.  
  102.  GETSFCB 
  103.  
  104.    This routine locates  the submit  FCB in the command processor  and returns
  105. its address in DE.   If SUBMIT is not enabled or if ZCPR33  is  not in memory,
  106. then  the  routine returns  with  the  Z flag set.   All other  registers  are
  107. preserved.
  108. :k
  109.  
  110.  
  111.  GETSRUN 
  112.  
  113.    This routine determines whether or not  a SUBMIT job is currently  running.
  114. If one is, the routine returns NZ.  Only register AF is affected.
  115. :l
  116.  
  117.  
  118.  GETSUB 
  119.  
  120.    This routine gets the XSUB input redirection flag into the A register.   No
  121. other registers are affected.
  122. :m
  123.  
  124.  
  125.  HALTSUB 
  126.  
  127.    This routine stops a submit job by deleting the $$$.SUB file.   It uses the
  128. submit  FCB  in the command processor so that it adapts automatically   to the
  129. correct drive and file name and type.  No registers are affected.
  130. :n
  131.  
  132.  
  133.  HIGHUSER 
  134.  
  135.    This routine tests to  see  whether  or  not the command processor supports
  136. user  numbers  above 15.   If  ZCPR33  is  not running or if high user support
  137. is disabled,  then HIGHUSER  returns with the zero  flag  set.   No  registers
  138. except AF are affected.
  139. :o
  140.  
  141.  
  142.  PARSE2 
  143.  
  144.    This  routine  calls  the REPARSE  entry point  in the command processor to
  145. reparse the command line pointed to by HL.   It  is  the user's responsibility
  146. to  be  sure that  the command  processor has  not been overwritten in memory.
  147. No registers are changed.  The two default file control blocks are filled.
  148. :p
  149.  
  150.  
  151.  PDEFDU 
  152.  
  153.    This routine puts  the drive/user values  in  BC into  the CURDR and CURUSR 
  154. bytes in the message buffer,  making that directory the default directory.  No
  155. registers are affected.
  156. :q
  157.  
  158.  
  159.  PUTER1 
  160.  
  161.    This routine supercedes the  same routine in Z3LIB,  and  its purpose is to
  162. disable  the  function.   In ZCPR33 there  is  no  way to turn  external error
  163. handling on and  off other than loading  or clearing the error  command  line.
  164. The  flag formerly used for this  purpose  is  now used  for the command error
  165. flag,  which indicates  the kind  of command error  that  was detected.   This
  166. replacement routine does nothing
  167. :r
  168.  
  169.  
  170.  PUTER3 
  171.  
  172.    This  routine stores the  value  in register A into the command error flag.
  173. No registers are affected.
  174. :s
  175.  
  176.  
  177.  PUTERC 
  178.  
  179.    This routine supercedes the  same routine in Z3LIB and differs only in that
  180. it  limits the length  of the error command line  to 28 bytes,  since the four
  181. bytes at  the end of the command line space have been assigned other purposes.
  182. On entry,  HL points to  a  null-terminated command string.   This  string  is
  183. copied to the error command line,  if  it will fit.   If it will not fit, then
  184. the error command line is cleared, and on return A=0 and  the Z  flag  is set.
  185. On exit,  HL points  to the character in the  new command line just  after the
  186. last one copied.  Other registers are preserved.
  187. :t
  188.  
  189.  
  190.  PUTSUB 
  191.  
  192.    This routine  stores  the  contents  of  the A register into the XSUB input
  193. redirection flag.  No registers are affected.
  194. :u
  195.  
  196.  
  197.  QERROR 
  198.  
  199.    This routine returns Z if the command status flag in the message buffer has
  200. the error bit set.  Only register AF is affected.
  201. :v
  202.  
  203.  
  204.  REPARSE 
  205.  
  206.    This routine calls  the  REPARSE entry  point  in  the command processor to
  207. reparse  the  command  line  starting  one  token later.   It  is  the  user's
  208. responsibility to be sure that the command processor  has not been overwritten
  209. in memory.   No registers  are changed.   The  two default file control blocks
  210. are filled.
  211. :w
  212.  
  213.  
  214.  RESEPB 
  215.  
  216.    This routine resets  the external program  bit  in the command status flag.
  217. No registers are affected.
  218. :x
  219.  
  220.  
  221.  RETCST 
  222.  
  223.    This routine returns the address of the command status flag in HL.  None of
  224. the other registers is affected.
  225. :y
  226.  
  227.  
  228.  SCAN 
  229.  
  230.    This routine first initializes the FCB pointed to by DE  and then calls the
  231. SCAN entry point in the command processor to parse a single token  pointed  to
  232. by  HL into  it.   It is the user's responsibility to be sure that the command
  233. processor has  not been  overwritten  in  memory.   No  registers are changed.
  234. :z
  235.  
  236.  
  237.  SETEPB 
  238.  
  239.    This routine sets the external program bit in the command  status flag.  No
  240. registers are affected.
  241. :1
  242.  
  243.  
  244.  STOPXSUB 
  245.  
  246.    This routine resets the XSUB input redirection flag in  the message buffer.
  247. No registers are affected.
  248. :2
  249.  
  250.  
  251.  SUBON 
  252.  
  253.    This routine tests  to  see if  SUBMIT processing is enabled in the command
  254. processor.  If so,  it returns NZ.   It will return Z if SUBMIT is not enabled
  255. or  if  the  ZCPR33 command processor cannot be detected.   Only  register  AF
  256. is affected.
  257. :3
  258.  
  259.  
  260.  Z33CHK 
  261.  
  262.    This routine checks  to  see that the version of the CCP that is running is
  263. version 3.X.  Two tests must be passed.  First,  the version byte must be 3xH.
  264. Secondly,  the byte at offset 3 must be a relative  jump  instruction  (opcode 
  265. 18H).   If both tests pass,  the routine returns  with  the zero flag set (Z).  
  266. Otherwise the flag is reset (NZ).
  267. :4
  268.  
  269.  
  270.  Z33FNAME 
  271.  
  272.    This routine first initializes the FCB pointed  to by DE and then calls the
  273. SCAN entry point in the command processor to parse a  single token pointed  to
  274. by  HL into  it.   It is the user's responsibility to be sure that the command
  275. processor has not been  overwritten  in memory.   The routine  returns with HL
  276. pointing to  the character  the  delimited  the  token.   Valid delimiters are
  277. space, comma, semicolon, equals,  greater than,  less than,  underscore or any
  278. control character less than space.  No other registers are affected.
  279.