mpiMotionEventNotifyGet

Declaration

int32_t mpiMotionEventNotifyGet(MPIMotion            motion,
                             MPIEventMask         *eventMask,
                             MPIEventNotifyData   *eventNotifyData)

Required Header: stdmpi.h

Change History: Modified in 04.00.

Description

mpiMotionEventNotifyGet writes the event mask (that specifies the event type(s) for which host notification has been requested) to the location pointed to by eventMask. It also retrieves the user-specified addresses to be used for MPIEvent.userData and writes them into the location pointed to by eventNotifyData (if eventNotifyData is not NULL).

The event notification information in eventNotifyData is in addition to the event notification information in eventMask, i.e, the event notification information in eventMask and in eventNotifyData is not the same information. Note that eventMask or eventNotifyData can be NULL (but not both NULL).

Event notification is enabled for event types specified in eventMask, which is a bit mask generated by the logical OR of the MPIEventMask bits associated with the desired MPIEventType values.

Note: Event notification is disabled for event types not specified in eventmask.

Return Values
MPIMessageOK

mpiMotionEventNotifyGet

Declaration

Description

See Also