17.2.348. MPI_T_category_get_info

17.2.348.1. 语法

17.2.348.1.1. C语法

#include <mpi.h>

int MPI_T_category_get_info(int cat_index, char *name, int *name_len,
char *desc, int *desc_len, int *num_cvars, int *num_pvars,
int *num_categories)

17.2.348.2. 输入参数

cat_index: 要查询的类别索引。

17.2.348.3. 输入/输出参数

name_len: 名称字符串和/或缓冲区的长度。
desc_len: 描述字符串和/或缓冲区的长度。

17.2.348.4. 输出参数

name: 返回包含类别名称的字符串的缓冲区。
desc: 用于返回包含类别描述的字符串缓冲区。
num_cvars: 该类别中控制变量的数量。
num_pvars: 该类别中的性能变量数量。
num_categories: 类别中包含的类别数量。

17.2.348.5. 描述

MPI_T_category_get_info 可用于从类别中查询信息。该函数分别在参数 num_cvars、num_pvars 和 num_categories 中返回查询类别中的控制变量数量、性能变量数量和子类别数量。

17.2.348.6. 注意事项

该MPI工具接口函数返回两个字符串。此函数为每个字符串接收两个参数：一个用于存储字符串的缓冲区，以及一个初始必须指定缓冲区大小的长度值。如果传入的长度为n，则该函数最多将字符串的n-1个字符复制到相应缓冲区中，并将长度设置为实际复制的字符数减1。若长度参数为NULL或指定的长度值为0，则忽略对应的字符串缓冲区且不返回该字符串。

17.2.348.7. 错误

MPI_T_category_get_info 在以下情况下会失败：

MPI_T_ERR_NOT_INITIALIZED: MPI工具接口未初始化
MPI_T_ERR_INVALID_INDEX: 类别索引无效