<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN"> <HTML> <HEAD> <META NAME="GENERATOR" CONTENT="DOCTEXT"> <TITLE>MPE_Describe_info_state</TITLE> </HEAD> <BODY BGCOLOR="FFFFFF"> <A NAME="MPE_Describe_info_state"><H1>MPE_Describe_info_state</H1></A> Describe attributes of a state with byte informational data in MPI_COMM_WORLD. <H2>Synopsis</H2> <PRE> int MPE_Describe_info_state( int state_startID, int state_finalID, const char *name, const char *color, const char *format ) </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. <DT><B>format </B><DD>printf style %-token format control string for the state, the maximum length of the NULL-terminated string is, sizeof(CLOG_FORMAT), 40. If format is NULL, it is equivalent to calling MPE_Describe_state(). The fortran interface of this routine considers the zero-length string, "", and single-blank string, " ", as NULL. </DL> <P> <H2>Notes</H2> Adds a state definition to the logfile. States are added to a logfile 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>Notes on storage format control support</H2> The format control string is printf like, e.g. "Comment = %s". All the MPE %-token storage support is provided by SLOG-2. That is whatever supported by SLOG-2 will be supported by MPE. Currently, the following is supported. <P> %s : variable length string, byte buffer size is length of string + 2. <P> %h : 2-byte integer, printed as decimal integer, byte buffer size is 2. <P> %d : 4-byte integer, printed as decimal integer, byte buffer size is 4. <P> %l : 8-byte integer, printed as decimal integer, byte buffer size is 8. <P> %x : 4-byte integer, printed as hexadecimal integer, byte buffer size is 4. <P> %X : 8-byte integer, printed as hexadecimal integer, byte buffer size is 8. <P> %e : 4-byte float, printed as decimal float, byte buffer size is 4. <P> %E : 8-byte float, printed as decimal float, byte buffer size is 8. <BR> <P> <P> <H2>See Also</H2> MPE_Log_get_state_eventIDs(). <BR><P><B>Location:</B>../src/logging/src/mpe_log.c<P> </BODY></HTML>