vfmt_encode() — Apollo

VFMT_$ENCODE                      Domain/OS                       VFMT_$ENCODE


NAME
     vfmt_$encode - formatted write to a string

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

     void vfmt_$encode(
          char *control_string,
          char *string_buffer,
          int &buffer_size,
          int *string_length,
          ...)

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

     procedure vfmt_$encode(
          in control_string: univ vfmt_$string_t ;
          out string_buffer: univ vfmt_$string_t;
          in buffer_size: integer;
          out string_length: integer;
          in a1, a2, a3, a4, a5,
               a6, a7, a8, a9, a10,
               a11, a12, a13, a14, a15,
               a16, a17, a18, a19, a20: univ vfmt_$generic_signed_arg);

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

           integer*2 nchar
           parameter (nchar = 128)

           integer*2 buffer_size, string_length
           character control_string*(nchar), string_buffer*200
           integer*4 a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11
           integer*4 a12, a13, a14, a15, a16, a17, a18, a19, a20

           call vfmt_$encode(control_string, string_buffer, buffer_size, string_length,
          &                  a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11,
          &                  a12, a13, a14, a15, a16, a17, a18, a19, a20)

DESCRIPTION
     Vfmt_$encode encodes up to twenty source variables into an ASCII string
     whose format is defined by control_string, and writes the result into
     string_buffer.

     control_string
          A VFMT format string defining how to format the source variables.

     string_buffer
          A buffer allocated to receive the formatted string supplied by
          vfmt_$encode.

     buffer_size
          The number of bytes allocated at string_buffer to receive the for-
          matted string.  Vfmt_$encode will not write more than buffer_size
          bytes into string_buffer.

     string_length
          The number of bytes that vfmt_$encode wrote into string_buffer.

     a1, a2, a3, ... a19, a20
          Up to 20 source variables containing data to encode into ASCII.

NOTES
     A string field in control_string requires two source variables:  a char-
     acter array containing the value of the string, and a 2-byte integer
     variable specifying the number of bytes in the string.

SEE ALSO
     vfmt_$encode10, vfmt_$encode2, vfmt_$encode5.
Museum
