Scroll to navigation

MPI_T_EVENT_READ(3) Open MPI MPI_T_EVENT_READ(3)

NAME

MPI_T_event_read - Read the value of a event instance.

MPI_T_event_read — Read the value of a event instance.

SYNTAX

C Syntax

int MPI_T_event_read(MPI_T_event_instance event_instance, int


    element_index, void* buffer)


INPUT PARAMETERS

  • event_instance: event-instance handle provided to the callback function.
  • elem_index: index into the array of datatypes of the item to be queried.
  • buffer: pointer to a memory location to store the item data

DESCRIPTION

MPI_T_event_read allows users to copy one element of the event data to a userspecified buffer at a time.

ERRORS

MPI_T_event_read will fail if:

  • MPI_T_ERR_NOT_INITIALIZED: The MPI Tools interface is not initialized.
  • MPI_T_ERR_INVALID_HANDLE: The handle is invalid.
  • MPI_T_ERR_INVALID_HANDLE: Invalid use of the interface or bad parameter values(s).
  • MPI_T_ERR_OTHER: Other error

See also:

  • MPI_T_event_copy <#mpi-t-event-copy>
  • MPI_T_Events <#mpi-t-events>
  • MPI_T <#mpi-t>



Author

The Open MPI community

Copyright

2003-2026, The Open MPI Community

October 13, 2026