Distributed-Run-Time-Resource-Manager/RCCE_V2.0/man/man3/.svn/text-base/RCCE_init.3.svn-base

.TH RCCE 3  2010-02-04 "RCCE MANPAGE" "RCCE Library"
.SH NAME
RCCE_init \- RCCE intitialization function 
.SH SYNOPSIS
.B #include <rcce.h>
.sp
.BI "int RCCE_init(int *" argc ", char ***" argv );
.SH DESCRIPTION
The
.BR RCCE_init() 
is the RCCE initialization function.  It is analogous to 
.BR MPI_init() 
and provides a place for any code required to set up the environment 
for RCCE programs. 
.BR RCCE_init() 
is a collective routine that must be 
encountered jointly by all UEs. It must be the first RCCE statement in 
the program. It must also come before any statements that read or 
write the argc and/or argv variables.
.TP
.B argc
Pointer to the number of application arguments on the command line.
.TP
.B argv
Pointer to a pointer to an array of strings (application command line arguments). 
.SH "RETURN VALUE"
Upon successful completion
.BR RCCE_init ()
returns
.BR RCCE_SUCCESS .
.SH ERRORS
Look in 
.BR rcce.h
for additional error codes.
.SH "SEE ALSO"
rcce.h(5)
.SH EXAMPLE
.PP
This example is taken from RCCE_pingpong.c in the apps directory.
.PP
#include <string.h> 
.br
#include <stdio.h> 
.br
#include "RCCE.h" 
.br
.br
#define BUFSIZE  32 
.br
#define MAXROUND 10 
.br
int RCCE_APP(int argc, char **argv){
.br
  int YOU, ME, round;
.br
  double timer;
.br
  char buffer[BUFSIZE+1];
.br
     .
.br
     .
.br
     .
.br
.br
.BI  "  RCCE_init(&argc,"" &argv);"
.br
  RCCE_debug_set(RCCE_DEBUG_ALL);
.br
     .
.br
     .
.br
     .
.br
.br
  return(0);
.br
}