MPI 04.00 Reference >> mpiMotion

mpiMotionEventNotifySet

Declaration

int32_t mpiMotionEventNotifySet(MPIMotion                 motion,
                             const MPIEventMask         *eventMask,
                             const 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).

Event notification is enabled for event types specified in eventMask, a bit mask generated by the bitwise OR of the MPIEventMask bits associated with the desired MPIEventType values. Event notification is disabled for event types that are not specified in eventMask.

The mask of event types generated by a Motion object consists of bits from MPIEventMaskMOTION and MPIEventMaskAXIS.

Remarks

To
Then
enable host notification of all events set eventMask to MPIEventMaskALL
disable host notification of all events set eventMask to MPIEventTypeNONE
Return Values
MPIMessageOK

See Also

MPIEventType | MPIEventNotifyData | mpiEventMaskMOTION | mpiEventMaskAXIS | mpiMotionEventNotifyGet