mbx_server_window()

MBX_$SERVER_WINDOW                Domain/OS                 MBX_$SERVER_WINDOW


NAME
     mbx_$server_window - return server buffer size

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

     int mbx_$server_window(
          void *&mbx_handle,
          short &mbx_channel,
          status_$t *status)

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

     function mbx_$server_window(
          in mbx_handle: univ_ptr;
          in mbx_channel: integer;
          out status: status_$t): integer32;

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

           integer*4 size, mbx_handle, mbx_channel, status

           size =  mbx_$server_window(mbx_handle, mbx_channel, status)

DESCRIPTION
     Mbx_$server_window returns the size of the largest message that can suc-
     cessfully be sent by a server to the client using channel number
     mbx_channel of the mailbox on mbx_handle.  The maximum message size
     returned by mbx_$server_window is measured in bytes.  If the value
     returned by mbx_$server_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
          A mailbox handle.

     mbx_channel
          A channel number.

     status
          The completion status.
Museum
