mpid_err_create_code.tex

刚才是说明 现在是安装程序在 LINUX环境下进行编程的MPICH安装文件

\startmanpage
\mantitle{MPID{\tt \char`\_}Err{\tt \char`\_}create{\tt \char`\_}code}{tex}{10/7/2002}
\manname{MPID{\tt \char`\_}Err{\tt \char`\_}create{\tt \char`\_}code}
--- Create an error code and associated message to report an error 
\subhead{Synopsis}
\startvb\begin{verbatim}
int MPID_Err_create_code( int class, const char *generic_msg, 
                          const char *instance_msg, ... )

\end{verbatim}
\endvb

\subhead{Input Parameters}
\startarg{class }{Error class
}
\startarg{generic{\tt \char`\_}msg }{A generic message to be used if not instance-specific
message is available
}
\startarg{instance{\tt \char`\_}msg }{A message containing printf-style formatting commands
that, when combined with the instance{\tt \char`\_}parameters, specify an error
message containing instance-specific data.
}
\startarg{instance{\tt \char`\_}parameters }{The remaining parameters.  These must match
the formatting commands in {\tt instance{\tt \char`\_}msg}.
}
\par
\subhead{Notes}
A typical use is:
\begin{verbatim}
   mpi_errno = MPID_Err_create_code( MPI_ERR_RANK, "Invalid Rank",
                                "Invalid rank %d", rank );
\end{verbatim}

\par
Predefined message may also be used.  Any message that uses the
prefix {\tt "**"} will be looked up in a table.  This allows standardized
messages to be used for a message that is used in several different locations
in the code.  For example, the name {\tt "**rank"} might be used instead of
{\tt "Invalid Rank"}; this would also allow the message to be made more
specific and useful, such as
\begin{verbatim}
   Invalid rank provided.  The rank must be between 0 and the 1 less than
   the size of the communicator in this call.
\end{verbatim}

\par
This interface is compatible with the {\tt gettext} interface for
internationalization, in the sense that the {\tt generic{\tt \char`\_}msg} and {\tt instance{\tt \char`\_}msg
}may be used as arguments to {\tt gettext} to return a string in the appropriate
language; the implementation of {\tt MPID{\tt \char`\_}Err{\tt \char`\_}create{\tt \char`\_}code} can then convert
this text into the appropriate code value.
\par
\subhead{Module}
Error
\par
\endmanpage