Open MPI logo

MPI_Info_set(3) man page (version 1.3.4)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing



NAME

       MPI_Info_set - Adds a key/value pair to info.

SYNTAX


C Syntax

       #include <mpi.h>
       int MPI_Info_set(MPI_Info info, char *key, char *value)

Fortran Syntax

       INCLUDE 'mpif.h'
       MPI_INFO_SET(INFO, KEY, VALUE, IERROR)
            INTEGER        INFO, IERROR
            CHARACTER*(*)  KEY, VALUE

C++ Syntax

       #include <mpi.h>
       void MPI::Info::Set(const char* key, const char* value)

INPUT/OUTPUT PARAMETER

       info      Info object (handle).

INPUT PARAMETERS

       key       Key (string).

       value     Value (string).

OUTPUT PARAMETER

       IERROR    Fortran only: Error status (integer).

DESCRIPTION

       MPI_Info_set  adds the (key,value) pair to info and overrides the value
       if a value for the same key was  previously  set.  The  key  and  value
       parameters  are  null-terminated  strings in C. In Fortran, leading and
       trailing spaces in key and value are stripped. If either key  or  value
       is  larger  than  the  allowed  maximums, the error MPI_ERR_INFO_KEY or
       MPI_ERR_INFO_VALUE is raised, respectively.

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.

1.3.4                            Nov 11, 2009                  MPI_Info_set(3)

« Return to documentation listing