MPI_INFO_DELETE(3)

πŸ’– MPI_INFO_DELETE πŸ’–

okay bestie, so this is the Open MPI page for MPI_Info_delete β€” and fr fr, the name is giving exactly what it does: it says goodbye to a key/value pair in your info object. no cap. ✨


🌸 NAME 🌸

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 β€” the Info object (a handle). it's giving both in and out energy, iykyk.

πŸ“ INPUT PARAMETER

  • key β€” the key, as a string. literally the name of the thing you're yeeting.

⭐ OUTPUT PARAMETER

  • ierror β€” Fortran only: error status (integer).

πŸ‘‘ DESCRIPTION πŸ‘‘

MPI_Info_delete deletes a (key,value) pair from info. super straightforward, main character behavior honestly.

but listen β€” if key is not defined in info, the call raises an error of class MPI_ERR_INFO_NOKEY. so if you're out here deleting keys that never existed, the universe will let you know. πŸ’€


πŸ’œ ERRORS πŸ’œ

Almost all MPI routines return an error value; C routines as the return result of the function and Fortran routines in the last argument.

Before the error value is returned, the current MPI error handler associated with the communication object (e.g., communicator, window, file) is called. 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 info key to MPI_Comm_spawn/MPI_Comm_spawn_multiple. 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.

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. chill, no drama, just a little code handed back to you. 🫢

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. so like… don't count on it. that's the whole caveat, no cap.

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

2003-2026, The Open MPI Community


okay that's the whole page, you ate it bestie πŸ’…βœ¨ this was MPI_INFO_DELETE(3) from Open MPI, dated Sep 10, 2026 β€” copyright 2003-2026, The Open MPI Community. go forth and delete responsibly, mwah πŸŽ€πŸ¦‹πŸ’–

πŸ“¦ where this page comes from