mpi_type_size.3

MPI stands for the Message Passing Interface. Written by the MPI Forum (a large committee comprising

.\"Copyright 2006, Sun Microsystems, Inc.
.\" Copyright (c) 1996 Thinking Machines Corporation
.TH MPI_Type_size 3OpenMPI "September 2006" "Open MPI 1.2" " "
.SH NAME
\fBMPI_Type_size\fP \- Returns the number of bytes occupied by entries in a data type.

.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Type_size(MPI_Datatype \fIdatatype\fP, int\fI *size\fP)

.SH Fortran Syntax
.nf
INCLUDE 'mpif.h'
MPI_TYPE_SIZE(\fIDATATYPE, SIZE, IERROR\fP)
	INTEGER	\fIDATATYPE, SIZE, IERROR\fP 

.SH C++ Syntax
.nf
#include <mpi.h>
int Datatype::Get_size() const

.SH INPUT PARAMETER
.ft R
.TP 1i
datatype      
Datatype (handle).
.sp

.SH OUTPUT PARAMETERS
.ft R
.TP 1i
size     
Datatype size (integer).
.sp
.ft R
.TP 1i
IERROR
Fortran only: Error status (integer). 

.SH DESCRIPTION
.ft R
MPI_Type_size returns the total size, in bytes, of the entries in the type signature associated with datatype; i.e., the total size of the data in a message that would be created with this datatype. Entries that occur multiple times in the datatype are counted with their multiplicity.  

.SH ERRORS
Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI:Exception object.
.sp
Before the error value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; 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.  

' @(#)MPI_Type_size.3 1.20 06/03/09