Developer

API Reference

ITransitionMgr_GetRunMode()

Brew Release
Brew MP 1.0.2
See Also
- ITransitionMgr_GetProperty()
- ITransitionMgr_SetRunMode()
Description
This function is a ITransitionMgr_GetProperty shortcut used to get the run mode of the manager. This mode is used to determine how the manager will be stepped. An active manager will be self-sufficient. Once started, it will set up a callback timer based on its step time. A passive manager acts like a transition in that it requires an external source calling its step function to advance. Note that only a passive manager can be set to keep transitions.
Parameters
  • pif
    []:
    [in] Pointer to the ITransitionMgr interface object.
  • pnVal
    []:
    [out] Pointer to integer to hold the property's value.
Prototype
   int ITransitionMgr_GetRunMode(ITransitionMgr* pif, int *pnVal)
Return
   AEE_SUCCESS      - The requested property has been retrieved.
   AEE_EBADPARM     - Invalid out parameter.
   ECLASSNOTSUPPORT - The requested property is not supported.
Side Effect
None
Comment
Run mode can be set to the following values:
   ITransitionMgr_PVAL_RUNMODE_PASSIVE - The manager will receive step calls
                                         from an outside source.
   ITransitionMgr_PVAL_RUNMODE_ACTIVE  - The manager will set it's own callback timer.
  • Follow