17.2.357. MPI_T_enum_get_info

MPI_T_enum_get_info — 查询枚举器的相关信息

17.2.357.1. 语法

17.2.357.1.1. C语法

#include <mpi.h>

int MPI_T_enum_get_info(MPI_T_enum enumtype, int *num, char *name, int *name_len)

17.2.357.2. 输入参数

  • enumtype: 要查询的枚举类型。

17.2.357.3. 输入/输出参数

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

17.2.357.4. 输出参数

  • num: 此枚举表示的离散值数量。

  • name: 返回包含类别名称的字符串的缓冲区。

17.2.357.5. 描述

MPI_T_enum_get_info 可用于查询枚举器的相关信息。该函数通过 num 参数返回此枚举器所表示的离散值的数量。

17.2.357.6. 注意事项

此MPI工具接口函数以字符串形式返回枚举名称。该函数接收两个字符串参数:name指定存储枚举名称的缓冲区,name_len初始值必须指定name指向缓冲区的大小。本函数最多复制name_len-1个字符的名称,并将name_len设为返回字符数+1。若name_len为NULL或name_len指定值为0,则忽略name缓冲区且不返回枚举名称。

17.2.357.7. 错误

MPI_T_enum_get_info 在以下情况下会失败:

  • MPI_T_ERR_NOT_INITIALIZED: MPI工具接口未初始化

  • MPI_T_ERR_INVALID_INDEX: 枚举无效或已被删除