pad_close_frame()

PAD_$CLOSE_FRAME                  Domain/OS                   PAD_$CLOSE_FRAME


NAME
     pad_$close_frame - close a frame

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

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

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

     procedure pad_$close_frame(
          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_$close_frame(stream_id, status)

DESCRIPTION
     Pad_$close_frame closes the frame open on the pad specified by stream_id.
     Closing a frame saves the frame's current image in a pad.

     stream_id
          The stream ID of the pad the frame is open on.

     status
          The completion status.

SEE ALSO
     pad_$clear_frame, pad_$create_frame, pad_$delete_frame.
Museum
