Edit

Share via

MPI_Unpack function

  • Article

Unpacks a buffer according to a datatype into contiguous memory.

Syntax

int MPIAPI MPI_Unpack(
        _In_bytecount_(insize) void *inbuf,
        int                         insize,
        _Inout_ int                 *position,
  _Out_ void                        *outbuf,
        int                         outcount,
        MPI_Datatype                datatype,
        MPI_Comm                    comm
);

Parameters

  • inbuf
    Start address of the input buffer.

  • insize
    Size of input buffer, in bytes.

  • position
    Current position in bytes.

  • outbuf [out]
    Start address of the output buffer.

  • outcount
    Number of items to be unpacked.

  • datatype
    Datatype of each output data item.

  • comm
    Communicator for packed message.

Return value

Returns MPI_SUCCESS on success. Otherwise, the return value is an error code.

In Fortran, the return value is stored in the IERROR parameter.

Fortran

    MPI_UNPACK(INBUF, INSIZE, POSITION, OUTBUF, OUTCOUNT, DATATYPE, COMM, IERROR)
        <type> INBUF(*), OUTBUF(*)
        INTEGER INSIZE, POSITION, OUTCOUNT, DATATYPE, COMM, IERROR

Requirements

Product

HPC Pack 2012 MS-MPI Redistributable Package, HPC Pack 2008 R2 MS-MPI Redistributable Package, HPC Pack 2008 MS-MPI Redistributable Package or HPC Pack 2008 Client Utilities

Header

 Mpi.h; Mpif.h

Library

 Msmpi.lib

DLL

 Msmpi.dll

See also

MPI Datatype Functions