Skip to content

Latest commit

 

History

History
79 lines (50 loc) · 1.27 KB

MPI_Info_delete.3.rst

File metadata and controls

79 lines (50 loc) · 1.27 KB
Raw

MPI_Info_delete

:ref:`MPI_Info_delete` - Deletes a key/value pair from info.

SYNTAX

C Syntax

#include <mpi.h>

int MPI_Info_delete(MPI_Info info, const char *key)

Fortran Syntax

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

Fortran 2008 Syntax

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

INPUT/OUTPUT PARAMETER

  • info: Info object (handle).

INPUT PARAMETER

  • key: Key (string).

OUTPUT PARAMETER

  • ierror: Fortran only: Error status (integer).

DESCRIPTION

:ref:`MPI_Info_delete` deletes a (key,value) pair from info. If key is not defined in info, the call raises an error of class MPI_ERR_INFO_NOKEY.

ERRORS

.. seealso::
   * :ref:`MPI_Info_create`
   * :ref:`MPI_Info_dup`
   * :ref:`MPI_Info_free`
   * :ref:`MPI_Info_get`
   * :ref:`MPI_Info_set`