Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > b96b0d782c858619536ab397b702cc7e > files > 15

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_Describe_state</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<A NAME="MPE_Describe_state"><H1>MPE_Describe_state</H1></A>
Describe the attributes of a state without byte informational data in MPI_COMM_WORLD. 
<H2>Synopsis</H2>
<PRE>
int MPE_Describe_state( int state_startID, int state_finalID,
                        const char *name, const char *color )
</PRE>
<H2>Input Parameters</H2>
<DL>
<DT><B>state_startID </B><DD>event number for the beginning of the state.

<DT><B>state_finalID </B><DD>event number for the ending of the state.

<DT><B>name          </B><DD>name of the state,
the maximum length of the NULL-terminated string is,
sizeof(CLOG_DESC), 32.

<DT><B>color         </B><DD>color of the state,
the maximum length of the NULL-terminated string is,
sizeof(CLOG_COLOR), 24.
</DL>
<P>
<H2>Notes</H2>
Adds a state definition to the logfile.
States are added to a log file by calling 'MPE_Log_event()'
for the start and end event numbers.  The function is provided
for backward compatibility purpose.  Users are urged to
use 'MPE_Describe_comm_state()' and 'MPE_Log_comm_event()' instead.
<P>
This function is threadsafe.
<P>
<H2>See Also</H2>
 MPE_Log_get_state_eventIDs(), MPE_Describe_comm_state()
<BR><P><B>Location:</B>../src/logging/src/mpe_log.c<P>
</BODY></HTML>