mbx_client_window()

MBX_$CLIENT_WINDOW                Domain/OS                 MBX_$CLIENT_WINDOW


NAME
     mbx_$client_window - return client buffer size

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

     int mbx_$client_window(
          void *&mbx_handle,
          status_$t *status)

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

     function mbx_$client_window(
          in mbx_handle: univ_ptr;
          out status: status_$t): integer32;

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

           integer*4 size, mbx_handle, status

           size = mbx_$client_window(mbx_handle, status)

DESCRIPTION
     Mbx_$client_window returns the size of the largest message that can suc-
     cessfully be sent by a client using the mailbox on mbx_handle.  The max-
     imum message size returned by mbx_$client_window is measured in bytes.
     If the value returned by mbx_$client_window is greater than mbx_$msg_max,
     it is valid only if all the nodes a message passes through are running
     SR9 or later software.  Messages less than mbx_$msg_max bytes long can be
     forwarded by any version of the mailbox helper without problems.

     mbx_handle
          The handle for the destination mailbox.

     status
          The completion status.
Museum
