17.2.378. MPI_T_event_handle_alloc

MPI_T_event_handle_alloc - Allocate event handles

17.2.378.1. SYNTAX

17.2.378.1.1. C Syntax

int MPI_T_event_handle_alloc(int event_index, void* obj_handle,
    MPI_Info info, MPI_T_event_registration* event_registration)

17.2.378.2. INPUT PARAMETERS

  • event_index: Index of event type for which the registration handle is to be allocated.

  • obj_handle: reference to a handle of the MPI object to which this event is supposed to be bound.

  • info: Info object.

17.2.378.3. OUTPUT PARAMETERS

  • event_registration: Event registration.

17.2.378.4. DESCRIPTION

MPI_T_event_handle_alloc binds the control variable specified in event_index to the MPI object specified in obj_handle. If MPI_T_event_get_info returns MPI_T_BIND_NO_OBJECT as the binding of the variable the obj_handle argument is ignored.

17.2.378.5. ERRORS

MPI_T_event_handle_alloc 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