Synopsis
int MPI_T_category_get_cvars(int cat_index, int len, int indices[])
Input Parameters
- cat_index
-
index of the category to be queried, in the range $0$ and $num_cat-1$ (integer)
- len
-
the length of the indices array (integer)
Output Parameters
- indices
-
an integer array of size len, indicating control variable indices (integer)
Description
MPI_T_category_get_cvars queries which control variables are contained in a particular category.
This routine has local semantics and a category contains zero or more control variables. The user is responsible for allocating the indices array. Starting from array index 0, the function writes up to len elements into the array. If the category contains more than len elements, the function returns an arbitrary subset of size len; otherwise, the entire set is returned in the beginning entries and remaining array entries are not modified. The returned index values may be used as input to MPI_T_CVAR_GET_INFO.
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_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.