Sophie: mpich2-doc-1.0.8-2mdv2010.0 i586

mpich2-doc-1.0.8-2mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MPE_CaptureFile</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<A NAME="MPE_CaptureFile"><H1>MPE_CaptureFile</H1></A>
Sets the base filename used to capture output from updates 
<H2>Synopsis</H2>
<PRE>
#include "mpe.h" 
int MPE_CaptureFile( handle, fname, freq )
MPE_XGraph handle;
char       *fname;
int        freq;
</PRE>
<H2>Input Parameters</H2>
<DL>
<DT><B>handle </B><DD>MPE graphics handle

<DT><B>fname  </B><DD>base file name (see below)

<DT><B>freq   </B><DD>Frequency of updates
</DL>
<P>
<H2>Return Values</H2>
<DL>
<DT><B>MPE_ERR_LOW_MEM </B><DD>malloc for copy of the filename (fname) failed

<DT><B>MPE_ERR_BAD_ARGS </B><DD>'handle' parameter is bad

<DT><B>MPE_SUCCESS </B><DD>success
</DL>
<P>
<H2>Notes</H2>
The output is written in xwd format to 'fname%d', where '%d' is the number
of the file (starting from zero).
<P>
<P>
<H2>Notes For Fortran Interface </H2>
The Fortran interface to this routine is different from its C
counterpart and it has an additional argument, ierr, at the end
of the argument list, i.e. the returned function value (the error
code) in C interface is returned as the additional argument in
Fortran interface.  The Fortran interface is invoked with the
CALL statement.
<P>
All MPI and MPE objects, MPI_Comm, MPE_XGraph and MPE_Color, are
of type INTEGER in Fortran.
<P>
<H2>Additional Notes for Fortran Interface </H2>
The trailing blanks in Fortran 'CHARACTER' string argument will be
ignored.
<P><B>Location:</B>../src/graphics/src/mpe_graphics.c<P>
</BODY></HTML>