pad_clear_frame()

PAD_$CLEAR_FRAME                  Domain/OS                   PAD_$CLEAR_FRAME


NAME
     pad_$clear_frame - clear a frame

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

     void pad_$clear_frame(
          ios_$id_t &stream_id,
          stream_$sk_t &seek_key,
          status_$t *status)

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

     procedure pad_$clear_frame(
          in stream_id: ios_$id_t;
          in seek_key: univ stream_$sk_t;
          out status: status_$t);

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

           integer*4 seek_key(3), rec_adr, byte_adr, flags, status
           integer*2 stream_id

           equivalence (rec_adr, seek_key(1))
           equivalence (byte_adr, seek_key(2))
           equivalence (flags, seek_key(3))

           call pad_$clear_frame(stream_id, seek_key, status)

DESCRIPTION
     Pad_$clear_frame clears data from a frame from the point specified in
     seek_key to the end of the frame.

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

     seek_key
          The offset in bytes from the beginning of the frame where clearing
          should start.  If the first four bytes of seek_key are 0, the entire
          frame is cleared.  An appropriate seek key can be obtained by a call
          to ios_$inq_full_key.

     status
          The completion status.

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