ios_seek_short_key()

IOS_$SEEK_SHORT_KEY               Domain/OS                IOS_$SEEK_SHORT_KEY


NAME
     ios_$seek_short_key - seek with a short key

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

     void ios_$seek_short_key(
          ios_$id_t &stream_id,
          long &short_key,
          status_$t *status)

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

     procedure ios_$seek_short_key(
          in stream_id: ios_$id_t;
          in short_key: integer32;
          out status: status_$t);

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

           integer*2 stream_id
           integer*4 short_key, status

           call ios_$seek_short_key(stream_id, short_key, status)

DESCRIPTION
     Ios_$seek_short_key moves the stream marker to the record described by
     short_key.  Do not try to create a short key from scratch because its
     format and value depend on the type manager for the object open on
     stream_id.  The only guarantee is that a call to ios_$seek_short_key will
     return a stream marker to the same record it was in when
     ios_$inq_short_key was called to obtain the key.

     stream_id
          The ID of the stream to seek on.

     short_key
          A short seek key provided by ios_$inq_short_key.

     status
          The completion status.

NOTES
     Domain/OS offers both short (4-byte) and full (8-byte) seek keys.
     Because short seek keys require half the storage space of full seek keys,
     they are useful when a program stores a large number of seek keys.  How-
     ever, short keys allow seeking to record boundaries only, while full keys
     allow seeking into records.

SEE ALSO
     ios_$seek, ios_$seek_full_key.
Museum
