NAME

       MPI_T_cvar_handle_alloc -  Allocate a handle for a control variable

SYNOPSIS

       int MPI_T_cvar_handle_alloc(int cvar_index, void *obj_handle,
       MPI_T_cvar_handle *handle, int *count)

INPUT PARAMETERS

       cvar_index
              - index of control variable for which handle is to be allocated (index)
       obj_handle
              -  reference to a handle of the mpi object to which this variable is supposed to be
              bound (pointer)

OUTPUT PARAMETERS

       handle - allocated handle (handle)
       count  - number of elements used to represent this variable (integer)

THREAD AND INTERRUPT SAFETY

       This routine is thread-safe.  This means that this routine may be safely used by  multiple
       threads  without the need for any user-provided thread locks.  However, the routine is not
       interrupt safe.  Typically, this is due to the use of memory allocation routines  such  as
       malloc or other non-MPICH runtime routines that are themselves not interrupt-safe.

ERRORS

       All  MPI  routines  (except MPI_Wtime and MPI_Wtick ) return an error value; C routines as
       the value of the function and Fortran routines in the last argument.  Before the value  is
       returned,  the current MPI error handler is called.  By default, this error handler aborts
       the MPI  job.   The  error  handler  may  be  changed  with  MPI_Comm_set_errhandler  (for
       communicators),  MPI_File_set_errhandler  (for files), and MPI_Win_set_errhandler (for RMA
       windows).  The MPI-1 routine MPI_Errhandler_set may be used but  its  use  is  deprecated.
       The  predefined  error  handler  MPI_ERRORS_RETURN may be used to cause error values to be
       returned.  Note that MPI does not guarantee that an  MPI  program  can  continue  past  an
       error; however, MPI implementations will attempt to continue whenever possible.

       MPI_SUCCESS
              - No error; MPI routine completed successfully.
       MPI_T_ERR_INVALID
              - Invalid use of the interface or bad parameter values(s).
       MPI_T_ERR_INVALID_INDEX
              - Index is invalid or has been deleted.
       MPI_T_ERR_NOT_INITIALIZED
              - The MPI tool information interface is not initialized.
       MPI_T_ERR_OUT_OF_HANDLES
              - No more handles available.
       MPI_ERR_OTHER
              - Other error; use MPI_Error_string to get more information about this error code.

                                             2/9/2024                  MPI_T_cvar_handle_alloc(3)