All procedures defined as part of the MPI tool information interface return an integer return code (see Table 23) to indicate whether the function was completed successfully or was aborted. For the former case, the value MPI_SUCCESS is returned. In the latter case, the return code indicates the reason for not completing the routine. Regardless of whether the return code is MPI_SUCCESS or indicates that the procedure abnormally terminated, the MPI process continues normal execution and does not invoke any MPI error handler. The MPI implementation is not required to check all user-provided parameters; if a user passes invalid parameter values to any routine, the behavior of the implementation is undefined.
All return codes with the prefix MPI_T_ERR_ must be unique values and cannot overlap with any error codes or error classes returned by the MPI implementation. They must also satisfy
0 = errorMPI_SUCCESS < errorskipMPI_T_ERR_XXX/ ≥ errorMPI_ERR_LASTCODE.
Table 23: Return codes used in procedures of the MPI tool information interface.
