vfmt_decode5()

VFMT_$DECODE5                     Domain/OS                      VFMT_$DECODE5


NAME
     vfmt_$decode5 - formatted read from a string

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

     int vfmt_$decode(
          char *control_string,
          char *source_string,
          int &source_length,
          int *decode_count,
          status_$t *status,
          void *a1, *a2, *a3, *a4, *a5)

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

     function vfmt_$decode5(
          in control_string: univ vfmt_$string_t;
          in source_string: univ vfmt_$string_t;
          in source_length: integer;
          out decode_count: integer;
          out status: status_$t;
          var a1, a2, a3, a4, a5:
               univ vfmt_$generic_unsigned_arg): integer;

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 return_value, source_length, decode_count
           character control_string*(nchar), source_string*200
           integer*4 a1, a2, a3, a4, a5

           last = vfmt_$decode5(control_string, source_string, source_length,
          &                     decode_count, status,
          &                     a1, a2, a3, a4, a5)

DESCRIPTION
     Vfmt_$decode5 decodes an ASCII source_string, formatted into fields as
     defined by control_string, into five destination variables, and returns
     the number of bytes from source_string decoded into the destination vari-
     ables.

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

     source_string
          An ASCII string to decode.

     source_length
          The number of bytes in source_string.

     decode_count
          The number of fields in source_string decoded into the destination
          variables.

     status
          The completion status.

     a1, a2, a3, a4, a5
          Destination variables to receive the decoded data.

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_$decode5 and the maximum
     string length specified in the call.

SEE ALSO
     vfmt_$decode10, vfmt_$decode2.
Museum
