mbx_get_ec() — Apollo

MBX_$GET_EC                       Domain/OS                        MBX_$GET_EC


NAME
     mbx_$get_ec - get a pointer to a mailbox eventcount

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

     void mbx_$get_ec(
          void *&mbx_handle,
          mbx_$ec_key_t &mbx_key,
          ec2_$ptr_t *eventcount_pointer,
          status_$t *status)

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

     procedure mbx_$get_ec(
          in mbx_handle: univ_ptr;
          in mbx_key: mbx_$ec_key_t;
          out eventcount_pointer: ec2_$ptr_t;
          out status: status_$t);

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

           integer*4 mbx_handle, status, ec_value
           integer*2 mbx_key, event(3)

           equivalence (ec_value, event(3))

           integer*4 eventcount_pointer
           pointer /eventcount_pointer/ event

           call mbx_$get_ec(mbx_handle, mbx_key, eventcount_pointer, status)

DESCRIPTION
     Mbx_$get_ec supplies eventcounts for the mailbox on mbx_handle.

     mbx_handle
          A mailbox handle.

     mbx_key
          The type of eventcount to get a pointer to. Specify one of the fol-
          lowing:

          mbx_$getrec_ec_key
               Get an eventcount that advances when a new message is waiting
               for the caller.

          mbx_$putrec_ec_key
               Get an eventcount that advances whenever a message leaves the
               caller's channel.

     eventcount_pointer
          A pointer to the eventcount.

     status
          The completion status.

SEE ALSO
     ec2_$intro.
Museum
