17.3. Deprecated since MPI-4.0

PreviousUpNext
Up: Deprecated Interfaces Next: Deprecated since MPI-4.1 Previous: Deprecated since MPI-2.2

Cancelling a send request by calling MPI_CANCEL has been deprecated and may be removed in a future version of the MPI specification.

The following function is deprecated and is superseded by the new MPI_INFO_GET_STRING call in MPI-4.0.

MPI_INFO_GET(info, key, valuelen, value, flag)
IN infoinfo object (handle)
IN keykey (string)
IN valuelenlength of value associated with key (integer)
OUT valuevalue (string)
OUT flag true if key defined, false if not (logical)
C binding
int MPI_Info_get(MPI_Info info, const char *key, int valuelen, char *value, int *flag)
Fortran 2008 binding
MPI_Info_get(info, key, valuelen, value, flag, ierror)
TYPE(MPI_Info), INTENT(IN) :: info
CHARACTER(LEN=*), INTENT(IN) :: key
INTEGER, INTENT(IN) :: valuelen
CHARACTER(LEN=valuelen), INTENT(OUT) :: value
LOGICAL, INTENT(OUT) :: flag
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
Fortran binding
MPI_INFO_GET(INFO, KEY, VALUELEN, VALUE, FLAG, IERROR)
INTEGER INFO, VALUELEN, IERROR
CHARACTER*(*) KEY, VALUE
LOGICAL FLAG

This function retrieves the value associated with key in a previous call to MPI_INFO_SET. If such a key exists, it sets flag to true and returns the value in value, otherwise it sets flag to false and leaves value unchanged. valuelen is the number of characters available in value. If it is less than the actual size of the value, the value is truncated. In C, valuelen should be one less than the amount of allocated space to allow for the null terminator.

If key is larger than MPI_MAX_INFO_KEY, the call is erroneous.

The function MPI_INFO_GET is allowed to be called at any time, following the description for MPI functionality that is always available in Section MPI Functionality that is Always Available.

The following function is deprecated and is superseded by the new MPI_INFO_GET_STRING call in MPI-4.0.

MPI_INFO_GET_VALUELEN(info, key, valuelen, flag)
IN infoinfo object (handle)
IN keykey (string)
OUT valuelenlength of value associated with key (integer)
OUT flag true if key defined, false if not (logical)
C binding
int MPI_Info_get_valuelen(MPI_Info info, const char *key, int *valuelen, int *flag)
Fortran 2008 binding
MPI_Info_get_valuelen(info, key, valuelen, flag, ierror)
TYPE(MPI_Info), INTENT(IN) :: info
CHARACTER(LEN=*), INTENT(IN) :: key
INTEGER, INTENT(OUT) :: valuelen
LOGICAL, INTENT(OUT) :: flag
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
Fortran binding
MPI_INFO_GET_VALUELEN(INFO, KEY, VALUELEN, FLAG, IERROR)
INTEGER INFO, VALUELEN, IERROR
CHARACTER*(*) KEY
LOGICAL FLAG

Retrieves the length of the value associated with key. If key is defined, valuelen is set to the length of its associated value and flag is set to true. If key is not defined, valuelen is not touched and flag is set to false. The length returned in C does not include the end-of-string character.

If key is larger than MPI_MAX_INFO_KEY, the call is erroneous.

The function MPI_INFO_GET_VALUELEN is allowed to be called at any time, following the description for MPI functionality that is always available in Section MPI Functionality that is Always Available.

The following return code has been deprecated and is superseded by a new name in MPI-4.0.

Deprecated Name Replacement Name
MPI_T_ERR_INVALID_ITEM MPI_T_ERR_INVALID_INDEX

The following Fortran subroutines are deprecated because the Fortran language storage_size() and c_sizeof() intrinsic functions provide similar functionality. Note that while MPI_SIZEOF and c_sizeof() return the size in bytes, storage_size() provides the size in bits.

MPI_SIZEOF(x, size)
IN xa Fortran variable of numeric intrinsic type (choice)
OUT sizesize of machine representation of that type (integer)
Fortran 2008 binding
MPI_Sizeof(x, size, ierror)
TYPE(*), DIMENSION(..) :: x
INTEGER, INTENT(OUT) :: size
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
Fortran binding
MPI_SIZEOF(X, SIZE, IERROR)
<type> X
INTEGER SIZE, IERROR

This function returns the size in bytes of the machine representation of the given variable. It is a generic Fortran routine and has a Fortran binding only.


Advice to users.

This function is similar to the C sizeof operator but behaves slightly differently. If given an array argument, it returns the size of the base element, not the size of the whole array. ( End of advice to users.)

Rationale.

This function is not available in other languages because it would not be useful. ( End of rationale.)


PreviousUpNext
Up: Deprecated Interfaces Next: Deprecated since MPI-4.1 Previous: Deprecated since MPI-2.2


Return to MPI-5.0 Standard Index
Return to MPI Forum Home Page

(Unofficial) MPI-5.0 of June 9, 2025
HTML Generated on March 2, 2025