mbx_put_chr() — Apollo

MBX_$PUT_CHR                      Domain/OS                       MBX_$PUT_CHR


NAME
     mbx_$put_chr - send a partial message

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

     void mbx_$put_chr(
          void *&mbx_handle,
          void *&buffer_pointer,
          long &buffer_length,
          status_$t *status)

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

     procedure mbx_$put_chr(
          in mbx_handle: univ_ptr;
          in buffer_pointer: univ_ptr;
          in buffer_length: integer32;
          out status: status_$t);

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

           integer*4 mbx_handle, buffer_length, status

           integer*4 buffer_pointer
           character buffer*32760
           pointer /buffer_pointer/ buffer

           call mbx_$put_chr(mbx_handle, buffer_pointer, buffer_length, status)

DESCRIPTION
     Mbx_$put_chr sends a message type mbx_$data_partial_mt to the mailbox on
     mbx_handle with the data supplied at buffer_ptr.  If there is not enough
     room for the message, mbx_$put_chr waits until the channel can accommo-
     date the message.

     mbx_handle
          A handle for the mailbox.

     buffer_pointer
          A pointer to a buffer containing data to be sent in the partial mes-
          sage.

     buffer_length
          The number of bytes to send from the buffer at buffer_pointer.
          Buffer_length must be less than mbx_$rec_data_max.

     status
          The completion status.

NOTES
     Mbx_$put_chr is for clients.  Servers can send partial messages with
     mbx_$put_rec or mbx_$put_rec_cond by specifying a message type of
     mbx_$data_partial_mt.  When the client fetches a partial message, its get
     call returns a status of mbx_$partial_record.
Museum
