mpiAxisEventNotifyGet
Declaration
mpiAxisEventNotifyGet(MPIAxis axis,
MPIEventMask *eventMask,
MPIEventNotifyData *eventNotifyData);
Required Header: axis.h
Change History: Modified in 04.00.
Description
mpiAxisEventNotifyGet reads the event mask (that specifies the event types for the requested host notification) to the location pointed to by eventMask, and also writes the event notification structure (that specifies the event message controller addresses) to the location pointed to by eventNotifyData.
Use the event mask macros mpiEventMaskGET(...), mpiEventMaskBitGET(...), etc. to decode the eventMask.
| axis | A handle to an Axis object |
|---|---|
| *eventMask | A pointer to an event mask, whose bits are defined by the MPIEventType enumeration |
| *eventNotifyData | A pointer to an event notification data structure, containing a list of controller addresses. The event data specified by the addresses is copied into the event message by the controller. |
| Return Values |
|---|
| MPIMessageOK |
Sample Code
/* Request notification of all events from axis */
mpiEventMaskCLEAR(eventMask);
returnValue =
mpiAxisEventNotifyGet(axis,
&eventMask,
NULL);
mpiEventMaskAXIS(eventMask);
if (returnValue == MPIMessageOK) {
returnValue =
mpiAxisEventNotifySet(axis,
eventMask,
NULL);
}