mpiAxisEventNotifyGet

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

AxisEventNotifyGet writes the event mask (that specifies the event type(s) for which host notification has been requested) to the location pointed to by eventMask, and also writes it into 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. See remarks below
     
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).

Return Values
MPIMessageOK if AxisEventNotifyGet successfully writes the event mask to the location(s)
See Also MEIEventNotifyData | MEIEventStatusInfo | mpiAxisEventNotifySet