← Back to branch summary

~ubuntu-branches/ubuntu/karmic/scilab/karmic

« back to all changes in this revision

Viewing changes to man/pvm/pvm_getinst.cat

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2002-03-21 16:57:43 UTC
  • Revision ID: james.westby@ubuntu.com-20020321165743-e9mv12c1tb1plztg
Tags: upstream-2.6
Import upstream version 2.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/pvm/pvm_getinst.cat
 
1
pvm_getinst       Scilab // Group       Scilab function         pvm_getinst
 
2
NAME
 
3
   pvm_getinst - returns the instance number in a group of a PVM process.
 
4
  
 
5
CALLING SEQUENCE
 
6
 [inum] = pvm_getinst(group, tid)
 
7
PARAMETERS
 
8
 group : string, string group name of an existing group.
 
9
       
 
10
 tid   : integer, task identifier of a PVM process.
 
11
       
 
12
 inum  : integer, instance number returned by the routine.
 
13
       
 
14
DESCRIPTION
 
15
   pvm_getinst  takes a group name
 
16
  
 
17
   and a PVM task identifier
 
18
  
 
19
   and returns the unique instance number that corresponds to the input. It
 
20
  can be called by any task whether in the group or not. If pvm_getinst is
 
21
  successful,
 
22
  
 
23
   will be >= 0. If some error occurs then
 
24
  
 
25
   will be < 0. 
 
26
  
 
27
EXAMPLE
 
28
 inum = pvm_getinst( "worker", pvm_mytid() )
 
29
SEE ALSO
 
30
   pvm_joingroup, pvm_gettid
 
31