mpiMotorEventNotifyGet

Declaration

long mpiMotorEventNotifyGet(MPIMotor     motor,
                            MPIEventMask *eventMask,
                            void         *external) 

Description

mpiMotorEventNotifyGet 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).

Event notification is enabled for event types specified in eventmask, which is a bit mask of MPIEventMask bits associated with the desired MPIEventType values. Event notification is disabled for event types not specified in eventmask. The MPIEventMask bits must be set of cleared using the MPIEventMask macros.

Remarks

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).

See Also

MPIEventType | MEIEventNotifyData | MEIEventStatusInfo | mpiMotorEventNotifySet