<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN"> <HTML> <HEAD> <META NAME="GENERATOR" CONTENT="DOCTEXT"> <TITLE>MPI_Type_get_attr</TITLE> </HEAD> <BODY BGCOLOR="FFFFFF"> <A NAME="MPI_Type_get_attr"><H1>MPI_Type_get_attr</H1></A> Retrieves attribute value by key <H2>Synopsis</H2> <PRE> int MPI_Type_get_attr(MPI_Datatype type, int type_keyval, void *attribute_val, int *flag) </PRE> <H2>Input Parameters</H2> <DL> <DT><B>type </B><DD>datatype to which the attribute is attached (handle) <DT><B>type_keyval </B><DD>key value (integer) </DL> <P> <H2>Output Parameters</H2> <DL> <DT><B>attribute_val </B><DD>attribute value, unless flag = false <DT><B>flag </B><DD>false if no attribute is associated with the key (logical) </DL> <P> <H2>Notes</H2> Attributes must be extracted from the same language as they were inserted in with <TT>MPI_Type_set_attr</TT>. The notes for C and Fortran below explain why. <P> <H2>Notes for C</H2> Even though the <TT>attr_value</TT> arguement is declared as <TT>void *</TT>, it is really the address of a void pointer. See the rationale in the standard for more details. <P> <H2>Thread and Interrupt Safety</H2> <P> This routine is thread-safe. This means that this routine may be safely used by multiple threads without the need for any user-provided thread locks. However, the routine is not interrupt safe. Typically, this is due to the use of memory allocation routines such as <TT>malloc </TT>or other non-MPICH runtime routines that are themselves not interrupt-safe. <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_KEYVAL </B> <DD> Invalid keyval </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_get_attr.c<P> </BODY></HTML>