17.2.59. MPI_Comm_free_keyval
MPI_Comm_free_keyval — 释放通信器缓存属性的键值
17.2.59.1. 语法
17.2.59.1.1. C语法
#include <mpi.h>
int MPI_Comm_free_keyval(int *comm_keyval)
17.2.59.1.2. Fortran语法
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_COMM_FREE_KEYVAL(COMM_KEYVAL, IERROR)
INTEGER COMM_KEYVAL, IERROR
17.2.59.1.3. Fortran 2008 语法
USE mpi_f08
MPI_Comm_free_keyval(comm_keyval, ierror)
INTEGER, INTENT(INOUT) :: comm_keyval
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
17.2.59.2. 输入/输出参数
comm_keyval:
17.2.59.3. 输出参数
ierror: 仅限Fortran：错误状态（整数）。
17.2.59.4. 描述
MPI_Comm_free_keyval 用于释放现有的属性键。该函数会将keyval的值设置为MPI_KEYVAL_INVALID。需要注意的是，释放正在使用的属性键并不会报错，因为实际的释放操作会等到该键的所有引用（位于进程中的其他通信器上）都被释放后才会执行。这些引用需要通过程序显式释放，可以通过调用MPI_Comm_delete_attr来释放单个属性实例，或者通过调用MPI_Comm_free来释放与被释放通信器关联的所有属性实例。
此调用与MPI_Keyval_free调用完全相同，但需要与MPI-2标准中引入的通信器特定创建函数相匹配。使用MPI_Keyval_free已被弃用。
17.2.59.5. 注意事项
键值是全局的（它们可以与任何及所有通信器一起使用）。
17.2.59.6. 错误
几乎所有MPI例程都会返回一个错误值；C语言例程通过函数返回值返回，Fortran例程则通过最后一个参数返回。
在返回错误值之前，会调用与通信对象（如通信器、窗口、文件）关联的当前MPI错误处理程序。如果MPI调用未关联任何通信对象，则该调用被视为附加到MPI_COMM_SELF，并将调用关联的MPI错误处理程序。当MPI_COMM_SELF未初始化时（即在MPI_Init/MPI_Init_thread之前、MPI_Finalize之后，或仅使用会话模型时），错误会触发初始错误处理程序。初始错误处理程序可通过在使用世界模型时调用MPI_Comm_set_errhandler来修改MPI_COMM_SELF，或通过mpiexec的mpi_initial_errhandler命令行参数，或MPI_Comm_spawn/MPI_Comm_spawn_multiple的info键来设置。如果未设置其他适当的错误处理程序，则MPI I/O函数将调用MPI_ERRORS_RETURN错误处理程序，而其他所有MPI函数将调用MPI_ERRORS_ABORT错误处理程序。
Open MPI 包含三个可使用的预定义错误处理器：
MPI_ERRORS_ARE_FATAL导致程序中止所有连接的MPI进程。MPI_ERRORS_ABORT一个可在通信器、窗口、文件或会话上调用的错误处理程序。当在通信器上调用时，其行为类似于在该通信器上调用MPI_Abort。如果在窗口或文件上调用，则行为类似于在包含对应窗口或文件中进程组的通信器上调用MPI_Abort。如果在会话上调用，则仅中止本地进程。MPI_ERRORS_RETURN向应用程序返回一个错误代码。
MPI应用程序也可以通过调用以下方式实现自己的错误处理程序：
请注意，MPI不保证MPI程序在出现错误后能够继续运行。
有关更多信息，请参阅MPI-3.1标准中的错误处理部分。