Skip to content

Latest commit

 

History

History
84 lines (55 loc) · 1.58 KB

MPI_Info_set.3.rst

File metadata and controls

84 lines (55 loc) · 1.58 KB

MPI_Info_set

MPI_Info_set Adds a key/value pair to info.

SYNTAX

C Syntax

#include <mpi.h>

int MPI_Info_set(MPI_Info info, const char *key, const char *value)

Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_INFO_SET(INFO, KEY, VALUE, IERROR)
 INTEGER     INFO, IERROR
 CHARACTER*(*)   KEY, VALUE

Fortran 2008 Syntax

USE mpi_f08
MPI_Info_set(info, key, value, ierror)
 TYPE(MPI_Info), INTENT(IN) :: info
 CHARACTER(LEN=*), INTENT(IN) :: key, value
 INTEGER, OPTIONAL, INTENT(OUT) :: ierror

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

* MPI_Info_create * MPI_Info_delete * MPI_Info_dup * MPI_Info_free * MPI_Info_set