File: MPI_T_enum_get_item.3in

package info (click to toggle)
openmpi 3.1.3-11
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 118,572 kB
  • sloc: ansic: 628,972; f90: 17,993; makefile: 13,761; sh: 7,051; java: 6,360; perl: 3,215; cpp: 2,225; python: 1,350; lex: 988; fortran: 52; tcl: 12
file content (69 lines) | stat: -rw-r--r-- 1,990 bytes parent folder | download | duplicates (2)
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
.\" -*- nroff -*-
.\" Copyright 2013 Los Alamos National Security, LLC. All rights reserved.
.\" Copyright 2006-2008 Sun Microsystems, Inc.
.\" Copyright (c) 1996 Thinking Machines Corporation
.\" Copyright (c) 2010 Cisco Systems, Inc.  All rights reserved.
.\" $COPYRIGHT$
.TH MPI_T_enum_get_item 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.
.SH NAME
\fBMPI_T_enum_get_item\fP \- Query information about an enumerator
.
.SH SYNTAX
.ft R
.
.SH C Syntax
.nf
#include <mpi.h>
int MPI_T_enum_get_item(MPI_T_enum \fIenumtype\fP, int \fIindex\fP, int *\fIvalue\fP, char *\fIname\fP,
                        int *\fIname_len\fP)

.fi
.SH INPUT PARAMETERS
.ft R
.TP 1i
enumtype
Enumeration to be queried.
.TP 1i
index
Number of the value to be queried in this enumeration.

.SH INPUT/OUTPUT PARAMETERS
.ft R
.TP 1i
name_len
Length of the string and/or buffer for name.

.SH OUTPUT PARAMETERS
.ft R
.TP 1i
value
Variable value.
.TP 1i
name
Buffer to return the string containing the name of the
category.

.SH DESCRIPTION
.ft R
MPI_T_enum_get_item can be used to query information about an item in an enumerator. This function
returns the enumeration value in the \fIvalue\fP parameter.

.SH NOTES
.ft R
This MPI tool interface function returns the name of the item as a string. This function takes two
arguments for the string: a buffer to store the string, and a length which must initially specify the
size of the buffer. If the length passed is n then this function will copy at most n - 1 characters
of the string into the buffer and sets the length to the number of characters copied - 1. If the length
argument is NULL or the value specified in the length is 0 the string buffer is ignored and the
string is not returned. For more information see MPI-3 \[char167] 14.3.3.

.SH ERRORS
.ft R
MPI_T_enum_get_item() will fail if:
.TP 1i
[MPI_T_ERR_NOT_INITIALIZED]
The MPI Tools interface not initialized
.TP 1i
[MPI_T_ERR_INVALID_INDEX]
The enumeration is invalid or has been deleted