---
name: "MPI_Type_get_envelope_c"
section: "3"
platform: "linux"
package: "mpich-doc"
version: "4.0.2-3"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/MPI_Type_get_envelope_c"
---

# MPI\_Type\_get\_envelope\_c(3)

get type envelope

## NAME

MPI\_Type\_get\_envelope\_c -  get type envelope

## SYNOPSIS

```
int MPI_Type_get_envelope_c(MPI_Datatype datatype, MPI_Count *num_integers,
MPI_Count *num_addresses, MPI_Count *num_large_counts,
MPI_Count *num_datatypes, int *combiner)
```

## INPUT PARAMETERS

- **datatype**

  \- datatype to access (handle) (handle)

## OUTPUT PARAMETERS

- **num\_integers**

  \- number of input integers used in call constructing combiner (non-negative integer) (non-negative integer)

- **num\_addresses**

  \- number of input addresses used in call constructing combiner (non-negative integer) (non-negative integer)

- **num\_large\_counts**

  \- number of input large counts used in call constructing combiner (non-negative integer)

- **num\_datatypes**

  \- number of input datatypes used in call constructing combiner (non-negative integer) (non-negative integer)

- **combiner**

  \- combiner (state) (state)

## NOTES FOR FORTRAN

All MPI routines in Fortran (except for  *MPI\_WTIME* and  *MPI\_WTICK* ) have an additional argument  *ierr* at the end of the argument list.   *ierr* is an integer and has the same meaning as the return value of the routine in C.  In Fortran, MPI routines are subroutines, and are invoked with the *call* statement.

All MPI objects (e.g.,  *MPI\_Datatype* ,  *MPI\_Comm* ) are of type  *INTEGER* in Fortran.

## ERRORS

All MPI routines (except  *MPI\_Wtime* and  *MPI\_Wtick* ) return an error value; C routines as the value of the function and Fortran routines in the last argument.  Before the value is returned, the current MPI error handler is called.  By default, this error handler aborts the MPI job.  The error handler may be changed with  *MPI\_Comm\_set\_errhandler* (for communicators), *MPI\_File\_set\_errhandler* (for files), and  *MPI\_Win\_set\_errhandler* (for RMA windows).  The MPI-1 routine  *MPI\_Errhandler\_set* may be used but its use is deprecated.  The predefined error handler *MPI\_ERRORS\_RETURN* may be used to cause error values to be returned. Note that MPI does  **not** guarantee that an MPI program can continue past an error; however, MPI implementations will attempt to continue whenever possible.

- **MPI\_SUCCESS**

  \- No error; MPI routine completed successfully.

- **MPI\_ERR\_ARG**

  \- Invalid argument.  Some argument is invalid and is not identified by a specific error class (e.g.,  *MPI\_ERR\_RANK* ).

- **MPI\_ERR\_TYPE**

  \- Invalid datatype argument.  Additionally, this error can occur if an uncommitted MPI\_Datatype (see  *MPI\_Type\_commit* ) is used in a communication call.

- **MPI\_ERR\_OTHER**

  \- Other error; use  *MPI\_Error\_string* to get more information about this error code.