17.2.396. MPI_T_source_get_info

MPI_T_source_get_info — Query information from a source

17.2.396.1. SYNTAX

17.2.396.1.1. C Syntax

#include <mpi.h>

int MPI_T_source_get_info(int source_index, char *name, int *name_len,
                          char *desc, int *desc_len, MPI_T_source_order *ordering,
                          MPI_Count *ticks_per_second, MPI_Count *max_ticks, MPI_Info *info)

17.2.396.2. INPUT PARAMETERS

source_index: Index of the source to be queried.

17.2.396.3. INPUT/OUTPUT PARAMETERS

name_len: Length of the string and/or buffer for name.
desc_len: Length of the string and/or buffer for desc.

17.2.396.4. OUTPUT PARAMETERS

name: Buffer to return the string containing the name of the source.
desc: Buffer to return the string containing the description of the source.
ordering: Flag indicating chronological ordering guarantees given by the source.
ticks_per_second: The number of ticks per second for the timer of this source.
max_ticks: The maximum count of ticks reported by this source before overflow occurs.
info: Info argument.

17.2.396.5. DESCRIPTION

MPI_T_source_get_info can be used to query information from a source.

17.2.396.6. ERRORS

MPI_T_source_get_info will fail if:

MPI_T_ERR_NOT_INITIALIZED: The MPI Tools interface not initialized
MPI_T_ERR_INVALID_INDEX: The source index is invalid