JOINGROUP(3PVM)						      JOINGROUP(3PVM)

NAME
  pvm_joingroup	- Enrolls the calling process in a named group.

SYNOPSIS
  C	  int inum = pvm_joingroup( char *group	)

  Fortran call pvmfjoingroup( group, inum )

PARAMETERS

  group	  Character string group name of an existing group.

  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_joingroup enrolls the	calling	task in	the group named	group
  and returns the instance number inum of this task in this group.  If there
  is an	error inum will	be negative.

  Instance numbers start at 0 and count	up.  When using	groups a (group,
  inum)	pair uniquely identifies a PVM process.	 This is consistent with the
  PVM 2.4 naming schemes.  If a	task leaves a group by calling pvm_lvgroup
  and later rejoins the	same group, the	task is	not guaranteed to get the
  same instance	number.	 PVM attempts to reuse old instance numbers, so	when
  a task joins a group it will get the lowest available	instance number.  A
  task can be a	member of multiple groups simultaneously.

EXAMPLES
  C:
	  inum = pvm_joingroup(	"worker" );

  Fortran:
	  CALL PVMFJOINGROUP( 'group2',	INUM )

ERRORS
  These	error conditions can be	returned by pvm_joingroup
       PvmSysErr      pvmd was not started or has crashed.
       PvmBadParam    giving a NULL group name.
       PvmDupGroup    trying to	join a group you are already in.

SEE ALSO
  pvm_lvgroup(3PVM)


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