mpiAxisEventNotifySet

Declaration

      mpiAxisEventNotifySet(MPIAxis                   axis,
                            const MPIEventMask        eventMask,
                            const MPIEventNotifyData  *eventNotifyData);

Required Header: axis.h

Change History: Modified in 04.00.

Description

mpiAxisEventNotifySet requests host notification of the events that are generated by axis and specified by eventMask, and also specified by 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 create the eventMask.

axis	A handle to a Axis object.
eventMask	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);
}

mpiAxisEventNotifySet

Declaration

Description

Sample Code

See Also