<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
<MAN>
  <LANGUAGE>eng</LANGUAGE>
  <TITLE>pvm_tasks</TITLE>
  <TYPE>Scilab function</TYPE>
  <DATE>May 1998</DATE>
  <SHORT_DESCRIPTION name="pvm_tasks"> information about the tasks running on the virtual machine.  </SHORT_DESCRIPTION>
  <CALLING_SEQUENCE>
    <CALLING_SEQUENCE_ITEM>res  = pvm_tasks([where])  </CALLING_SEQUENCE_ITEM>
  </CALLING_SEQUENCE>
  <PARAM>
    <PARAM_INDENT>
      <PARAM_ITEM>
        <PARAM_NAME>where</PARAM_NAME>
        <PARAM_DESCRIPTION>
          <SP>: (optional) integer, specifying what tasks to return information about. The options are:</SP>
          <VERBATIM>
<![CDATA[
 0(default) for all the tasks on the virtual machine
 pvmd tid for all tasks on a given host
   tid  for a specific task
   ]]>
          </VERBATIM>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>
      <PARAM_ITEM>
        <PARAM_NAME>res</PARAM_NAME>
        <PARAM_DESCRIPTION>
          <SP>:  list of 7 elements such that:</SP>
          <PARAM_INDENT>
            <PARAM_ITEM>
              <PARAM_NAME>res(1)  </PARAM_NAME>
              <PARAM_DESCRIPTION>
                <SP>:  integer returning task ID of one task</SP>
              </PARAM_DESCRIPTION>
            </PARAM_ITEM>
            <PARAM_ITEM>
              <PARAM_NAME>res(2)  </PARAM_NAME>
              <PARAM_DESCRIPTION>
                <SP>:  integer returning parent task ID</SP>
              </PARAM_DESCRIPTION>
            </PARAM_ITEM>
            <PARAM_ITEM>
              <PARAM_NAME>res(3)  </PARAM_NAME>
              <PARAM_DESCRIPTION>
                <SP>:  integer returning pvmd task ID of host task is on</SP>
              </PARAM_DESCRIPTION>
            </PARAM_ITEM>
            <PARAM_ITEM>
              <PARAM_NAME>res(4)  </PARAM_NAME>
              <PARAM_DESCRIPTION>
                <SP>:  integer returning status of task</SP>
              </PARAM_DESCRIPTION>
            </PARAM_ITEM>
            <PARAM_ITEM>
              <PARAM_NAME>res(5)  </PARAM_NAME>
              <PARAM_DESCRIPTION>
                <SP>:  string returning the name of spawned task. Manually started tasks return blank.</SP>
              </PARAM_DESCRIPTION>
            </PARAM_ITEM>
            <PARAM_ITEM>
              <PARAM_NAME>res(6)  </PARAM_NAME>
              <PARAM_DESCRIPTION>
                <SP>:  integer returning the number of tasks being reported on.</SP>
              </PARAM_DESCRIPTION>
            </PARAM_ITEM>
            <PARAM_ITEM>
              <PARAM_NAME>res(7)  </PARAM_NAME>
              <PARAM_DESCRIPTION>
                <SP>:  integer status code returned by the routine.</SP>
              </PARAM_DESCRIPTION>
            </PARAM_ITEM>
          </PARAM_INDENT>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>
    </PARAM_INDENT>
  </PARAM>
  <DESCRIPTION>
    <P><VERB>pvm_tasks</VERB> 
    returns information about
    tasks presently running on the virtual machine.
    The information returned is the same as
    that available from the console command</P>
    <P>
    The <VERB>pvm_tasks</VERB> function returns information about the entire
    virtual machine in one call.</P>
    <P>
    If pvm_tasks is successful,</P>
    <P>
    will be 0.
    If some error occurs then</P>
    <P>
    will be &lt; 0.</P>
    <P>
    for example:</P>
    <VERBATIM>
<![CDATA[
-->res = pvm_tasks()
 res  =
 
       res(1)
 
!   262148.    262151.    262152. !
 
       res(2)
 
!   262147.    0.    262151. !
 
       res(3)
 
!   262144.    262144.    262144. !
 
       res(4)
 
!   6.    4.    6. !
 
       res(5)
 
!pvmgs    /home/ubeda/SCILAB/scilab-2.4/bin/scilex  !
 
       res(6)
 
    3.  
 
       res(7)
 
    0. 
   ]]>
    </VERBATIM>
  </DESCRIPTION>
  <SEE_ALSO>
    <SEE_ALSO_ITEM>
      <LINK>pvm_config</LINK>
    </SEE_ALSO_ITEM>
    <SEE_ALSO_ITEM>
      <LINK>pvm_tidtohost</LINK>
    </SEE_ALSO_ITEM>
  </SEE_ALSO>
</MAN>
