Edit

Share via

MPI_Iprobe function

  • Article

Nonblocking test for a message.

Syntax

int MPIAPI MPI_Iprobe(
        int        source,
        int        tag,
        MPI_Comm   comm,
  _Out_ int        *flag,
  _Out_ MPI_Status *status
);

Parameters

  • source
    Source rank, or MPI_ANY_SOURCE.

  • tag
    Tag value, or MPI_ANY_TAG.

  • comm
    Communicator.

  • flag [out]
    True if a message with the specified source, tag, and communicator is available.

  • status [out]
    Status object.

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_IPROBE(SOURCE, TAG, COMM, FLAG, STATUS, IERROR)
        LOGICAL FLAG
        INTEGER SOURCE, TAG, COMM, STATUS(MPI_STATUS_SIZE), 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 Point to Point Functions