ios_inq_rec_pos()

IOS_$INQ_REC_POS                  Domain/OS                   IOS_$INQ_REC_POS


NAME
     ios_$inq_rec_pos - return the record position of a stream marker

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

     long ios_$inq_rec_pos(
          ios_$id_t &stream_id,
          ios_$pos_opt_t &position_option,
          status_$t *status)

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

     function ios_$inq_rec_pos(
          in stream_id: ios_$id_t;
          in position_option: ios_$pos_opt_t;
          out status: status_$t): integer32;

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

           integer*2 stream_id, position_option
           integer*4 record_position, status

           rec_pos = ios_$inq_rec_pos(stream_id, position_option, status)

DESCRIPTION
     Ios_$inq_rec_pos returns the position of a stream marker as an offset
     measured in records from the beginning of an object (BOF).  The position
     returned can be used in nonkeyed seeking on the stream and to calculate
     relative positions in the stream.

     stream_id
          The ID of the stream on which the object is open.

     position_option
          Choose one of the following positions:

          ios_$bof
               Return the position of the beginning of the object (BOF).
               Ios_$inq_rec_pos will always return 0 for the position of BOF.

          ios_$current
               Return the current position of the stream marker.

          ios_$eof
               Return the position of the end of the object (EOF).

     status
          The completion status.

NOTES
     A program can use ios_$inq_byte_pos to find the position of stream mark-
     ers in terms of bytes.

SEE ALSO
     ios_$seek.
Museum
