mpiUserLimitEventNotifySet

Declaration

MPI_DECL1 MPI_RESULT MPI_DECL2
   mpiUserLimitEventNotifySet(MPIUserLimit             userLimit,
                              const MPIEventNotifyData *eventNotifyData);

 

Required Header: stdmpi.h

Change History: Added in 04.00.

Description

mpiUserLimitEventNotifySet writes the user-specified controller addresses in eventNotifyData to the controller.  User limit events will include the data stored at these addresses when the event occurs.

userLimit The user limit object handle.
eventNotifyData A pointer where the user-specified addresses are stored.

Sample Code 

void userLimitAddBackgroundCycleTimestamp(MPIUserLimit userLimit, 
                                          MFWData* firmware)
    {
        MPI_RESULT                  returnValue;

        MPIEventNotifyData    eventNotifyData;

        returnValue = mpiUserLimitEventNotifyGet(userLimit, &eventNotifyData);

        msgCHECK(returnValue);

        eventNotifyData.address[0] = &firmware->SystemData.Data.BackgroundCycle;

        returnValue = mpiUserLimitEventNotifySet(userLimit, &eventNotifyData);

        msgCHECK(returnValue);
    }

See Also

mpiUserLimitEventNotifyGet | MPIEventData