VFMT_$RS10                        Domain/OS                         VFMT_$RS10


NAME
     vfmt_$rs10 - formatted read from a stream

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

     void vfmt_$rs10(
          int &stream_id,
          char *control_string,
          int *field_count,
          status_$t *status,
          void *a1, *a2, *a3, *a4, *a5, *a6, *a7, *a8, *a9, *a10)

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

     procedure vfmt_$rs10(
          in stream_id: univ integer;
          in control_string: univ vfmt_$string_t;
          out field_count: integer;
          out status: status_$t;
          var a1, a2, a3, a4, a5,
                    a6, a7, a8, a9, a10: univ vfmt_$generic_unsigned_arg);

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

           integer*2 nchar
           parameter (nchar = 128)

           integer*4 status
           integer*2 stream_id, field_count
           character control_string*(nchar)
           integer*4 a1, a2, a3, a4, a5, a6, a7, a8, a9, a10

           call vfmt_$rs10(stream_id, control_string, field_count, status,
          &                a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)

DESCRIPTION
     Vfmt_$rs10 reads an ASCII record from the stream specified by stream_id,
     formatted in fields as defined by control_string, into 10 destination
     variables.

     stream_id
          The stream ID of the stream to read from.

     control_string
          A VFMT format string defining the input fields to be decoded.

     field_count
          The number of input fields decoded into the destination variables.

     status
          The completion status.

     a1, a2, a3, a4, a5, a6, a7, a8, a9, a10
          Destination variables to receive the decoded input.

NOTES
     A string field in control_string requires two destination variables:  a
     character array to receive the value of the string, and a 2-byte integer
     variable to receive the number of bytes in the decoded string.

     The length of a string field can be defined in control_string with the M
     option or, if the M option is not present, by passing a maximum string
     length in the destination variable intended to receive the string length.
     Regardless of whether there is an M option associated with the string
     field, the value returned in the destination variable is the minimum of
     the actual length of the string supplied by vfmt_$rs10 and the maximum
     string length specified in the call.

SEE ALSO
     vfmt_$rs2, vfmt_$rs5.