Edit

MPI_Get_count function

  • Article

Gets the number of "top level" elements.

Syntax

int MPIAPI MPI_Get_count(
  _In_  MPI_Status   *status,
        MPI_Datatype datatype,
  _Out_ int          *count
);

Parameters

  • status [in]
    Return status of receive operation.

  • datatype
    Datatype of each receive buffer element.

  • count [out]
    Number of received elements.

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_GET_COUNT(STATUS, DATATYPE, COUNT, IERROR)
        INTEGER STATUS(MPI_STATUS_SIZE), DATATYPE, COUNT, IERROR

Remarks

If the size of the datatype is zero, this routine will return a count of zero. If the amount of data in status is not an exact multiple of the size of datatype (so that count would not be integral), a count of MPI_UNDEFINED is returned instead.

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