NAME

MPI_Unpack - Unpack a contiguous block of a type into a buffer

SYNOPSIS

#include <mpi.h> 
int MPI_Unpack(void *pack_buf , int pack_size , int *pos , void *buf , int count ,
	 MPI_Datatype datatype , MPI_Comm comm ); 
#include <pmpi.h> 
int PMPI_Unpack(void *pack_buf , int pack_size , int *pos , void *buf , int count ,
	 MPI_Datatype datatype , MPI_Comm comm ); 

INPUT PARAMETERS

pack_buf - buffer to unpack from (array).

pack_size - total size of pack_buf in bytes (integer)

pos - current offset into pack_buf (array).

count - number of contiguous copies of type (integer)

datatype - type (handle)

comm - communicator that only affects which error handler is called (handle)

OUTPUT PARAMETERS

pos - current offset into pack_buf (array).

buf - buffer to unpack into (array).

DESCRIPTION

The MPI_Unpack() function is used to unpack the data described by count contiguous copies of type datatype in buffer buf from the packed buffer pack_buf . The total size of the packed buffer is pack_size bytes. The current offset into the packed buffer is pos . This offset is updated when data is read from the packed buffer by this function.

The inverse of this function is MPI_Pack().

Even though the communicator, comm is not directly used by this function, it should be a valid one (not MPI_COMM_NULL).

PMPI_Unpack() is the profiling version of this function.

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error value. The the current MPI error handler is invoked if this return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable.

MPI_SUCCESS - No error;

MPI_ERR_COMM - Invalid communicator;

MPI_ERR_TYPE - Invalid data type;

MPI_ERR_COUNT - Invalid count;

MPI_ERR_ARG - Invalid pointer.

SEE ALSO

MPI_Type_size (3) MPI_Pack_size (3) MPI_Pack (3)

• Lockless
• MPI Documentation
• MPI_Unpack