Developer

API Reference

ITransitionMgr_Get()

Brew Release
Brew MP 1.0.2
See Also
- ITransitionMgr_GetTransProperty()
Description
Retrieves a transition living in the manager. This function is intended to be used as a batch grab of all transitions living in the manager at that point in time. The index of a transition may change from one step to another based on the order they are in the manager queue, thus a transition should never be paired to a specific index. An application that wishes to modify a transition after inserting it within a manager should not rely on this function to retrieve it, instead it should explicitly keep a reference to that transition.
Parameters
  • pif
    [in]:
    Pointer to the ITransitionMgr interface object.
  • nIndex
    [in]:
    Specifies the index of the wanted transition
  • ppiTrans
    [out]:
    Location to save retrieved transition
Prototype
   AEERESULT ITransitionMgr_Get(ITransitionMgr* pif, int nIndex, IQI** ppiTrans)
Return
   AEE_SUCCESS           : The manager stopped the transition successfully.
   AEE_EBADPARAM         : Invalid return location
   AEE_EFAILED           : No transition exist at specified index
Side Effect
None.
Comment
None.
  • Follow