cobol1.hlp (Topic list)
Important Notice
The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.
CBL_READ_FILE Details (↑ Library of Routines)
 Key Summary                             Up Contents Index Back
────────────────────────────────────────────────────────────────────────────
 
  Description:
 
     See Introduction to Byte-Stream Routines
 
  Parameters on Entry:
 
     file-handle             The file handle returned when the file was
                             opened.
 
     file-offset             The offset in file at which to read. This
                             field is currently limited to a maximum value
                             of x"00FFFFFFFF".
 
     byte-count              The number of bytes to read. This field is
                             currently limited to a maximum value of
                             x"00FFFF".
 
     flags                   This parameter can take the following values:
 
                                 0  for standard read
                               128  to have the current file size returned
                                    in the file-offset field
 
  Parameters on Exit:
 
     file-offset             Contains the current file size on return if
                             the flags parameter is set to 128 on entry.
 
     buffer                  The buffer into which the bytes are read. It
                             is your responsibility to ensure that the
                             buffer is large enough to hold the number of
                             bytes to be read.
 
                             The buffer parameter is allowed to cross a 64K
                             segment boundary.
                                    -♦-