MPI_INFO_DELETE(3)

📦
version 5.0.11 · 17 versions
, in arch rolling

💅 MPI_INFO_DELETE (Open MPI, section 3) 🎀

okay bestie, so this one is from the Open MPI manual, and honestly? it's a whole little icon. no cap.

✨ NAME ✨

MPI_Info_delete — deletes a key/value pair from info. that's it, that's the whole vibe. it's the "unfollow" button for your info object 💅

🌸 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

the mpi_f08 flavor is giving main character energy ngl, but the older forms still slay 🫶

🦋 INPUT/OUTPUT PARAMETER 🦋

  • info — the Info object (handle). it goes in, it comes out, it's changed. glow up AND glow down at the same time, iconic.

🎀 INPUT PARAMETER 🎀

  • key — the Key (string). this is the thing you're yeeting out of info ✨

💖 OUTPUT PARAMETER 💖

  • ierror — Fortran only: the error status (integer). classic Fortran behavior, always gotta be the one with the extra output parameter 🙈

👑 DESCRIPTION 👑

MPI_Info_delete deletes a (key,value) pair from info. the whole duo, both of them, gone. not just the value, not just the key — the pair.

and listen, if key is not defined in info, the call raises an error of class MPI_ERR_INFO_NOKEY. so like... you can't delete what was never there, bestie. vibe check failed 😭

🔥 ERRORS 🔥

so literally almost all MPI routines return an error value — C routines hand it back as the return result of the function, and Fortran routines tuck it into the last argument. periodt.

before the error value is returned, the current MPI error handler associated with the communication object (e.g., communicator, window, file) is called. and if no communication object is associated with the MPI call, then the call is considered attached to MPI_COMM_SELF and will call the associated MPI error handler. when MPI_COMM_SELF is not initialized (i.e., before MPI_Init/MPI_Init_thread, after MPI_Finalize, or when using the Sessions Model exclusively) the error raises the initial error handler. the initial error handler can be changed by calling MPI_Comm_set_errhandler on MPI_COMM_SELF when using the World model, or the mpi_initial_errhandler CLI argument to mpiexec, or the info key to MPI_Comm_spawn/MPI_Comm_spawn_multiple. and if no other appropriate error handler has been set, then the MPI_ERRORS_RETURN error handler is called for MPI I/O functions and the MPI_ERRORS_ABORT error handler is called for all other MPI functions. iykyk 💜

Open MPI includes three predefined error handlers that can be used:

  • MPI_ERRORS_ARE_FATAL — Causes the program to abort all connected MPI processes. like, everybody. gone. 💀
  • MPI_ERRORS_ABORT — An error handler that can be invoked on a communicator, window, file, or session. When called on a communicator, it acts as if MPI_Abort was called on that communicator. If called on a window or file, acts as if MPI_Abort was called on a communicator containing the group of processes in the corresponding window or file. If called on a session, aborts only the local process.
  • MPI_ERRORS_RETURN — Returns an error code to the application. the chill one. the "just tell me what happened" one 🫶

MPI applications can also implement their own error handlers by calling:

  • MPI_Comm_create_errhandler then MPI_Comm_set_errhandler
  • MPI_File_create_errhandler then MPI_File_set_errhandler
  • MPI_Session_create_errhandler then MPI_Session_set_errhandler or at MPI_Session_init
  • MPI_Win_create_errhandler then MPI_Win_set_errhandler
⚠️ note that MPI does not guarantee that an MPI program can continue past an error. fr fr, do not assume you can just keep going. 🚨

See the MPI man page for a full list of MPI error codes.

See the Error Handling section of the MPI-3.1 standard for more information.

🌈 SEE ALSO 🌈

  • MPI_Info_create
  • MPI_Info_dup
  • MPI_Info_free
  • MPI_Info_get
  • MPI_Info_set

the whole info squad, honestly obsessed with them 🌸

2003-2026, The Open MPI Community — like, two decades of service, we stan 👑

and that's the page!! 🦋 written by the Open MPI girlies, dated Sep 11, 2026, filed under MPI_INFO_DELETE(3) — go delete those keys, bestie, and don't forget your ierror 💖✨🎀

📦 where this page comes from