mpiAxisEventNotifySet

Declaration
long mpiAxisEventNotifySet(MPIAxis       axis,
                           MPIEventMask  eventMask,
                           void          *external) 
Required Header stdmpi.h
Description

AxisEventNotifySet requests host notification of the event(s) that are generated by axis and specified by eventMask, and also specified by the implementation-specific location pointed to by external (if external is not NULL).

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

  axis a handle to the Axis object
  eventMask pointer to an MPIEventMask
  *external pointer to an external
     
XMP Only

external either points to a structure of type MEIEventNotifyData{} or is NULL.

The MEIEventNotifyData{} structure is an array of firmware addresses, whose contents are placed into the MEIEventStatusInfo{} structure (of all events generated by this object).

To... Then...
enable host notification of all events configure eventmask with mpiEventMaskALL(eventMask)
disable host notification of all events

configure eventmask with mpiEventMaskCLEAR(eventMask)

Return Values
MPIMessageOK if AxisEventNotifySet successfully requests host notification of the event(s) that are specified by eventMask and generated by motion
See Also MEIEventNotifyData | MEIEventStatusInfo | MPIEventMask | MPIEventType |
mpiEventMaskALL | mpiEventMaskCLEAR | mpiAxisEventNotifyGet | MEIEventNotifyData