ios_inq_rec_remainder()

IOS_$INQ_REC_REMAINDER            Domain/OS             IOS_$INQ_REC_REMAINDER


NAME
     ios_$inq_rec_remainder - return the number of bytes left in a record

SYNOPSIS (C)
     #include <apollo/base.h>
     #include <apollo/ios.h>

     long ios_$inq_rec_remainder(
          ios_$id_t &stream_id,
          status_$t *status)

SYNOPSIS (Pascal)
     %include '/sys/ins/base.ins.pas';
     %include '/sys/ins/ios.ins.pas';

     function ios_$inq_rec_remainder(
          in stream_id: ios_$id_t;
          out status: status_$t): integer32;

SYNOPSIS (FORTRAN)
     %include '/sys/ins/base.ins.ftn'
     %include '/sys/ins/ios.ins.ftn'

           integer*2 stream_id
           integer*4 bytes, status

           bytes = ios_$inq_rec_remainder(stream_id, status)

DESCRIPTION
     Ios_$inq_rec_remainder returns the number of bytes remaining in the
     current record.

     If the next record is too large to entirely fit in the buffer provided
     for a call to ios_$get or ios_$locate, then only a part of the record
     will be read into the buffer and the call will return with the
     ios_$buffer_too_small error in its completion status.  A subsequent call
     to ios_$inq_rec_remainder will return the number of unread bytes remain-
     ing in the record.

     stream_id
          The ID of the stream open on the object.

     status
          The completion status.

NOTES
     The value returned by ios_$inq_rec_remainder is not defined unless a par-
     tial record has been read, so do not call it unless a previous ios_$get
     or ios_$locate call returned with ios_$buffer_too_small in its completion
     status.

SEE ALSO
     ios_$inq_cur_rec_len.
Museum
