17.2.358. MPI_T_enum_get_item

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

17.2.358.1. 语法

17.2.358.1.1. C语法

#include <mpi.h>

int MPI_T_enum_get_item(MPI_T_enum enumtype, int index, int *value, char *name,
                        int *name_len)

17.2.358.2. 输入参数

enumtype: 要查询的枚举类型。
index: 要在此枚举中查询的值的编号。

17.2.358.3. 输入/输出参数

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

17.2.358.4. 输出参数

value: 变量值。
name: 返回包含类别名称的字符串的缓冲区。

17.2.358.5. 描述

MPI_T_enum_get_item 可用于查询枚举器中某个条目的信息。该函数通过 value 参数返回枚举值。

17.2.358.6. 注意事项

该MPI工具接口函数以字符串形式返回项目名称。此函数接收两个字符串参数：用于存储字符串的缓冲区，以及必须初始指定缓冲区大小的长度值。如果传入的长度为n，则该函数最多将n-1个字符复制到缓冲区，并将长度设置为实际复制的字符数减1。若长度参数为NULL或指定值为0，则忽略字符串缓冲区且不返回字符串。更多信息请参阅MPI-3标准第14.3.3章节。

17.2.358.7. 错误

MPI_T_enum_get_item 在以下情况下会失败：

MPI_T_ERR_NOT_INITIALIZED: MPI工具接口未初始化
MPI_T_ERR_INVALID_INDEX: 枚举无效或已被删除