Edit

MPI_Error_string function

  • Article

Returns a string for a given error code.

Syntax

int MPIAPI MPI_Error_string(
        int                                                          errorcode,
        _Out_z_cap_post_count_(MPI_MAX_ERROR_STRING,*resultlen) char *string,
  _Out_ int                                                          *resultlen
);

Parameters

  • errorcode
    Error code returned by an MPI routine or an MPI error class.

  • string
    Text that corresponds to the errorcode.

  • resultlen [out]
    Length of string.

Return value

Returns MPI_SUCCESS on success. Otherwise, the return value is an error code.

In Fortran, the return value is stored in the IERROR parameter.

Fortran

    MPI_ERROR_STRING(ERRORCODE, STRING, RESULTLEN, IERROR)
        INTEGER ERRORCODE, RESULTLEN, IERROR
        CHARACTER*(*) STRING

Requirements

Product

HPC Pack 2012 MS-MPI Redistributable Package, HPC Pack 2008 R2 MS-MPI Redistributable Package, HPC Pack 2008 MS-MPI Redistributable Package or HPC Pack 2008 Client Utilities

Header

 Mpi.h; Mpif.h

Library

 Msmpi.lib

DLL

 Msmpi.dll

See also

MPI Management Functions