1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
|
.. _mpi_t_category_get_cvars:
MPI_T_category_get_cvars
========================
.. include_body
:ref:`MPI_T_category_get_cvars` |mdash| Query which control variables are in a
category
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_T_category_get_cvars(int cat_index, int len, int indices[])
INPUT PARAMETERS
----------------
* ``cat_index``: Index of the category to be queried.
* ``len``: The length of the indices array.
OUTPUT PARAMETERS
-----------------
* ``indices``: An integer array of size len, indicating control variable indices.
DESCRIPTION
-----------
:ref:`MPI_T_category_get_cvars` can be used to query which control variables
are contained in a particular category.
ERRORS
------
:ref:`MPI_T_category_get_cvars` will fail if:
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface not initialized
* ``MPI_T_ERR_INVALID_INDEX``: The category index is invalid
|