Scroll to navigation

MPI_T_CVAR_HANDLE_FREE(3) Open MPI MPI_T_CVAR_HANDLE_FREE(3)

NAME

MPI_T_cvar_handle_free - UNKNOWN



MPI_T_cvar_handle_alloc <#mpi-t-cvar-handle-alloc>, MPI_T_cvar_handle_free - Allocate/free control variable handles

DESCRIPTION

MPI_T_cvar_handle_alloc <#mpi-t-cvar-handle-alloc> binds the control variable specified in cvar_index to the MPI object specified in obj_handle. If MPI_T_cvar_get_info <#mpi-t-cvar-get-info> returns MPI_T_BIND_NO_OBJECT as the binding of the variable the obj_handle argument is ignored. The number of values represented by this control variable is returned in the count parameter. If the control variable represents a string then count will be the maximum length of the string.

MPI_T_cvar_handle_free frees a handle allocated by MPI_T_cvar_handle_alloc <#mpi-t-cvar-handle-alloc> and sets the handle argument to MPI_T_CVAR_HANDLE_NULL.

NOTES

Open MPI does not currently support binding MPI objects to control variables so the obj_handle argument is always ignored.

ERRORS

MPI_T_cvar_handle_alloc <#mpi-t-cvar-handle-alloc> will fail if:

  • MPI_T_ERR_NOT_INITIALIZED: The MPI Tools interface not initialized
  • MPI_T_ERR_INVALID_INDEX: The control variable index is invalid
  • MPI_T_ERR_OUT_OF_HANDLES: No more handles available

MPI_T_cvar_handle_free will fail if:

  • MPI_T_ERR_NOT_INITIALIZED: The MPI Tools interface not initialized
  • MPI_T_ERR_INVALID_HANDLE: The handle is invalid

See also:

•
MPI_T_cvar_get_info <#mpi-t-cvar-get-info>



Author

The Open MPI community

Copyright

2003-2026, The Open MPI Community

October 18, 2026