Open MPI logo

MPI_Type_set_name(3) man page (version 1.3.4)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing



NAME

       MPI_Type_set_name - Sets the name of a data type.

SYNTAX


C Syntax

       #include <mpi.h>
       int MPI_Type_set_name(MPI_Datatype type, char *type_name)

Fortran Syntax

       INCLUDE 'mpif.h'
       MPI_TYPE_SET_NAME(TYPE, TYPE_NAME, IERROR)
            INTEGER   TYPE, IERROR
            CHARACTER*(*) TYPE_NAME

C++ Syntax

       #include <mpi.h>
       void MPI::Datatype::Set_name(const char* type_name)

INPUT/OUTPUT PARAMETER

       type      Data type for which the identifier is to be set (handle).

INPUT PARAMETER

       type_name The character string remembered as the name (string).

OUTPUT PARAMETER

       IERROR    Fortran only: Error status (integer).

DESCRIPTION

       MPI_Type_set_name  associates  a  printable identifier with an MPI data
       type.

ERRORS

       Almost all MPI routines return an error value; C routines as the  value
       of  the  function  and Fortran routines in the last argument. C++ func-
       tions do not return errors. If the default  error  handler  is  set  to
       MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism
       will be used to throw an MPI:Exception object.

       Before the error value is returned, the current MPI  error  handler  is
       called.  By  default, this error handler aborts the MPI job, except for
       I/O  function  errors.  The  error  handler   may   be   changed   with
       MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN
       may be used to cause error values to be returned. Note  that  MPI  does
       not guarantee that an MPI program can continue past an error.

SEE ALSO

       MPI_Type_get_name

« Return to documentation listing