API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

ITRANSITIONMGR_STEP()

Brew Release
Brew MP 1.0.2
See Also
- ITransition2_Step()
Description
Step the manager to a certain offset. The manager will advance all the transitions within its queue that are ready to be stepped.
Params
pif
[]:
[in] Pointer to the ITransition2 interface object.
nOffset
[]:
[in] specifies the new step offset
nStatus
[]:
[out] Used to track the state of the manager
Interface
Prototype
  •     int ITransitionMgr_Step(ITransitionMgr* pif, int nOffset, int *pnStatus) 
    
Return
  •    AEE_SUCCESS - The manager successfully stepped forward
       AEE_EFAILED - The manager or one of its internal transitions failed to step
    
Side Effect
  • None.
Comments
pnStatus is set to TSTATUS_STEP_DONE if the manager has completed all it's internal transitions, otherwise it will be set to TSTATUS_STEP_MORE. If the manager is in passive mode, it will be dealt with normally by its master manager. If the manager is in active mode, it will put itself to sleep if no more transitions are in the queue, otherwise it will reset the timer.