<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN"> <HTML> <HEAD> <META NAME="GENERATOR" CONTENT="DOCTEXT"> <TITLE>MPI_Type_ub</TITLE> </HEAD> <BODY BGCOLOR="FFFFFF"> <A NAME="MPI_Type_ub"><H1>MPI_Type_ub</H1></A> Returns the upper bound of a datatype <H2>Synopsis</H2> <PRE> int MPI_Type_ub(MPI_Datatype datatype, MPI_Aint *displacement) </PRE> <H2>Input Parameters</H2> <DL><DT><B>datatype </B> <DD> datatype (handle) </DL> <P> <H2>Output Parameter</H2> <DL><DT><B>displacement </B> <DD> displacement of upper bound from origin, in bytes (address integer) </DL> <P> <H2>Deprecated Function</H2> The MPI-2 standard deprecated a number of routines because MPI-2 provides better versions. This routine is one of those that was deprecated. The routine may continue to be used, but new code should use the replacement routine. The replacement for this routine is <TT>MPI_Type_get_extent </TT> <P> <H2>Thread and Interrupt Safety</H2> <P> This routine is both thread- and interrupt-safe. This means that this routine may safely be used by multiple threads and from within a signal handler. <P> <H2>Notes for Fortran</H2> All MPI routines in Fortran (except for <TT>MPI_WTIME</TT> and <TT>MPI_WTICK</TT>) have an additional argument <TT>ierr</TT> at the end of the argument list. <TT>ierr </TT>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 <TT>call</TT> statement. <P> All MPI objects (e.g., <TT>MPI_Datatype</TT>, <TT>MPI_Comm</TT>) are of type <TT>INTEGER </TT>in Fortran. <P> <H2>Errors</H2> <P> All MPI routines (except <TT>MPI_Wtime</TT> and <TT>MPI_Wtick</TT>) 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 <TT>MPI_Comm_set_errhandler</TT> (for communicators), <TT>MPI_File_set_errhandler</TT> (for files), and <TT>MPI_Win_set_errhandler</TT> (for RMA windows). The MPI-1 routine <TT>MPI_Errhandler_set</TT> may be used but its use is deprecated. The predefined error handler <TT>MPI_ERRORS_RETURN</TT> may be used to cause error values to be returned. Note that MPI does <EM>not</EM> guarentee that an MPI program can continue past an error; however, MPI implementations will attempt to continue whenever possible. <P> <DL><DT><B>MPI_SUCCESS </B> <DD> No error; MPI routine completed successfully. </DL> <DL><DT><B>MPI_ERR_TYPE </B> <DD> Invalid datatype argument. May be an uncommitted MPI_Datatype (see <TT>MPI_Type_commit</TT>). </DL> <DL><DT><B>MPI_ERR_ARG </B> <DD> Invalid argument. Some argument is invalid and is not identified by a specific error class (e.g., <TT>MPI_ERR_RANK</TT>). </DL> <P><B>Location:</B>type_ub.c<P> </BODY></HTML>