GETINST(3PVM)							GETINST(3PVM)

NAME
  pvm_getinst -	Returns	the instance number in a group of a PVM	process.

SYNOPSIS
  C	  int inum = pvm_getinst( char *group, int tid )

  Fortran call pvmfgetinst( group, tid,	inum )

PARAMETERS

  group	  Character string group name of an existing group.

  tid	  Integer task identifier of a PVM process.

  inum	  Integer instance number returned by the routine.  Instance numbers
	  start	at 0 and count up.  Values less	than zero indicate an error.

DISCUSSION
  The routine pvm_getinst takes	a group	name group and a PVM task identifier
  tid and returns the unique instance number that corresponds to the input.
  It can be called by any task whether in the group or not.  If	pvm_getinst
  is successful, inum will be >= 0.  If	some error occurs then inum will be <
  0.

EXAMPLES
  C:
	  inum = pvm_getinst( "worker",	pvm_mytid() );
	  --------
	  inum = pvm_getinst( "worker",	tid[i] );

  Fortran:
	  CALL PVMFGETINST( 'GROUP3', TID, INUM	)

ERRORS
  These	error conditions can be	returned by pvm_getinst
       PvmSysErr      pvmd was not started or has crashed.
       PvmBadParam    giving an	invalid	tid value.
       PvmNoGroup     giving a non-existent group name.
       PvmNotInGroup  specifying a group in which the tid is not a member.

SEE ALSO
  pvm_joingroup(3PVM), pvm_gettid(3PVM)


Back to the alphabetical listing
Back to the listing of routines for advanced and group functions