Edit

Share via

MPI_Get_elements function

  • Article

Returns the number of basic elements in a datatype.

Syntax

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

Parameters

  • status [in]
    Return status of receive operation.

  • datatype
    Datatype used by receive operation.

  • count [out]
    Number of received basic 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_ELEMENTS(STATUS, DATATYPE, COUNT, IERROR)
        INTEGER STATUS(MPI_STATUS_SIZE), DATATYPE, COUNT, IERROR

Remarks

If the size of the datatype is zero and the amount of data returned as determined by status is also zero, this routine will return a count of zero.

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