<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
<MAN>
  <LANGUAGE>eng</LANGUAGE>
  <TITLE>pvm_bufinfo</TITLE>
  <TYPE>Scilab function</TYPE>
  <DATE>May 1998</DATE>
  <SHORT_DESCRIPTION name="pvm_bufinfo"> Returns information about a message buffer.  </SHORT_DESCRIPTION>
  <CALLING_SEQUENCE>
    <CALLING_SEQUENCE_ITEM>[bytes, msgtag, tid, info] = pvm_bufinfo(bufid)  </CALLING_SEQUENCE_ITEM>
  </CALLING_SEQUENCE>
  <PARAM>
    <PARAM_INDENT>
      <PARAM_ITEM>
        <PARAM_NAME>bufid</PARAM_NAME>
        <PARAM_DESCRIPTION>
          <SP>:   integer, specifying   a  particular  message buffer  identifier.</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>
      <PARAM_ITEM>
        <PARAM_NAME>bytes</PARAM_NAME>
        <PARAM_DESCRIPTION>
          <SP>: integer, size of the message in bytes  (not very useful inside scilab).</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>
      <PARAM_ITEM>
        <PARAM_NAME>msgtag</PARAM_NAME>
        <PARAM_DESCRIPTION>
          <SP>: integer,  label of the  message.  Useful when the message was 
    received with a wildcard msgtag.</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>
      <PARAM_ITEM>
        <PARAM_NAME>tid</PARAM_NAME>
        <PARAM_DESCRIPTION>
          <SP>: integer, task ID of the source of the message.</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>
      <PARAM_ITEM>
        <PARAM_NAME>info</PARAM_NAME>
        <PARAM_DESCRIPTION>
          <SP>: integer, status code returned by  the routine. Values less than 
    zero indicate an error.</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>
    </PARAM_INDENT>
  </PARAM>
  <DESCRIPTION>
    <P><VERB>pvm_bufinfo</VERB> returns information   about  the requested   message
    buffer.  Typically it is  used   to determine  facts  about the   last
    received   message  such  as   its size  or   source. <VERB>pvm_bufinfo</VERB> is
    especially useful when an application is  able to receive any incoming
    message, and the action taken depends on the source tid and the msgtag
    associated  with the message that comes  in first.</P>
    <P>
    The returned value <VERB>info</VERB>will be zero if 
    <VERB>pvm_bufinfo</VERB> is successful and will be 
    will be &lt; 0 if some error occurs.</P>
  </DESCRIPTION>
  <SEE_ALSO>
    <SEE_ALSO_ITEM>
      <LINK>pvm_recv</LINK>
    </SEE_ALSO_ITEM>
  </SEE_ALSO>
</MAN>
