Synopsis

int MPI_T_event_handle_get_info(MPI_T_event_registration event_registration,
                                MPI_Info *info_used)

Input Parameters

event_registration

event registration (handle)

Output Parameters

info_used

info object (handle)

Description

MPI_T_event_handle_get_info returns a new info object containing the hints of an event-registration handle.

This routine has local semantics. The current setting of all hints related to the registration handle is returned in info_used. An MPI implementation is required to return all hints that are supported by the implementation and have default values specified, any user-supplied hints that were not ignored by the implementation, and any additional hints that were set by the implementation. If no such hints exist, a handle to a newly created info object is returned that contains no key/value pairs. The user is responsible for freeing info_used via MPI_INFO_FREE.

Thread and Interrupt Safety

This routine is thread-safe. This means that this routine may be safely used by multiple threads without the need for any user-provided thread locks. However, the routine is not interrupt safe. Typically, this is due to the use of memory allocation routines such as 'malloc' or other non-MPICH runtime routines that are themselves not interrupt-safe.

Errors

All MPI routines (except 'MPI_Wtime' and 'MPI_Wtick') return an error value; C routines as the value of the function and Fortran routines in the last argument. Before the value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job. The error handler may be changed with 'MPI_Comm_set_errhandler' (for communicators), 'MPI_File_set_errhandler' (for files), and 'MPI_Win_set_errhandler' (for RMA windows). The MPI-1 routine 'MPI_Errhandler_set' may be used but its use is deprecated. The predefined error handler 'MPI_ERRORS_RETURN' may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error; however, MPI implementations will attempt to continue whenever possible.

  • MPI_SUCCESS - No error; MPI routine completed successfully.

  • MPI_T_ERR_INVALID - Invalid use of the interface or bad parameter values(s).

  • MPI_T_ERR_INVALID_HANDLE - The handle is invalid.

  • MPI_T_ERR_NOT_INITIALIZED - The MPI tool information interface is not initialized.

  • MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.