pad_cooked() — Apollo

PAD_$COOKED                       Domain/OS                        PAD_$COOKED


NAME
     pad_$cooked - put a transcript pad in cooked mode

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

     void pad_$cooked(
          ios_$id_t &stream_id,
          status_$t *status)

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

     procedure pad_$cooked(
          in stream_id: ios_$id_t;
          out status: status_$t);

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

           integer*4 status
           integer*2 stream_id

           call pad_$cooked(stream_id, status)

DESCRIPTION
     Pad_$cooked returns the pad to normal (cooked) processing if it is
     currently in raw mode due to a call to pad_$raw.  In cooked mode, input
     to the Display Manager is echoed and buffered until a record terminator
     (pad_$newline) is received, at which point the input record is displayed
     in the transcript pad and released to the process reading the pad.  Also
     in cooked mode, the Display Manager buffers output to a pad until a
     record terminator (pad_$newline) is written, then displays the entire
     record in the transcript pad.  Finally, if a partial record is written to
     a transcript pad and the corresponding input pad is read, the partial
     record will be displayed in the window on the input pad.

     The input and output preprocessing described previously is disabled in
     raw mode.

     Pad_$cooked has no effect if called when the pad is not in raw mode.
     Because the Display Manager must flush the input buffer when changing
     modes, a call to pad_$cooked empties the input pad.  Most programs assume
     pads are in cooked mode.

     stream_id
          The ID of the stream on which the pad is open.  Stream_id should
          refer to an input stream, usually standard input (ios_$stdin).

     status
          The completion status.

SEE ALSO
     pad_$force_prompt.
Museum
