Museum

IOS_$GET_EC                       Domain/OS                        IOS_$GET_EC


NAME
     ios_$get_ec - get a pointer to a stream eventcount

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

     void ios_$get_ec(
          ios_$id_t &stream_id,
          ios_$ec_key_t &stream_key,
          ec2_$ptr_t *eventcount_pointer,
          status_$t *status)

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

     procedure ios_$get_ec(
          in stream_id: ios_$id_t;
          in stream_key: ios_$ec_key_t;
          out eventcount_pointer: ec2_$ptr_t;
          out status: status_$t);

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

           integer*2 stream_id, stream_key, event(3)
           integer*4 status, value

           integer*4 eventcount_pointer
           pointer /eventcount_pointer/ event

           equivalence (value, event(1))

           call ios_$get_ec(stream_id, stream_key, eventcount_pointer, status)

DESCRIPTION
     Ios_$get_ec gets a pointer to a stream eventcount for use with Level 2
     Eventcount calls.

     stream_id
          The ID of the stream whose eventcount is needed.  The stream may be
          open on a pad, mailbox, or any other type of object whose manager
          uses eventcounts.

     stream_key
          Specify which type of eventcount to get a pointer to.  Choose one of
          the following:

          ios_$get_ec_key
               Get an eventcount that advances when data is added to the
               stream.  An ios_$get_rec_ec eventcount advances whenever there
               is something new on an open stream.  For example, if stream_id
               belongs to an input pad, the supplied eventcount advances after
               each carriage return if the pad is in cooked mode, and advances
               after each keystroke if the pad is in raw mode.

          ios_$put_ec_key
               Get an eventcount that advances when a previously full stream
               might now be able to accept data.

               Some objects cannot continually accept data, and streams open
               to them will block an ios_$put call until they can accept data.
               If stream_id belongs to such a stream, the supplied eventcount
               will advance when it is possible to write data to the previ-
               ously blocked stream.

     eventcount_pointer
          A pointer to the requested eventcount.

     status
          The completion status.

SEE ALSO
     ec2_$intro.