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

Developer

API Reference

ITRANSITIONMGR_STARTTRANSITION()

Brew Release
Brew MP 1.0.2
See Also
- ITransitionMgr_StopTransition() - ITransitionMgr_Remove()
Description
This function starts a transition in the manager. The effect of this function will depend on the state of the transition and the flags provided. See table below.
   Transition Status     Flag:None       Flag:Reset
   _________________     _________       __________
   
   running          |    no effect       reset
   paused           |    resume          reset and start
   stopped          |    resume          reset and start
   completed        |    no effect       reset and start
Params
pif
[in]:
Pointer to the ITransitionMgr interface object.
piTrans
[in]:
IQI pointer to the transition to be started.
nFlags
[in]:
Control flags.
Interface
Prototype
  •    AEERESULT ITransitionMgr_StartTransition(ITransitionMgr* pif,
                                                IQI* piTrans, uint32 nFlags)
    
Return
  • AEE_SUCCESS : The manager started the transition successfully. AEE_ERESOURCENOTFOUND : The transition does not exist in the manager. AEE_EFAILED : The manager failed to query the transition
Side Effect
  • None.
Comments
Possible control flags: ITransitionMgr_FLAG_STARTTRANS_RESET: Performs a reset before starting the transition