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

Developer

API Reference

ITRANSITIONMGR_GETKEEPTRANSITIONS()

Brew Release
Brew MP 1.0.2
See Also
- ITransitionMgr_GetProperty() - ITransitionMgr_SetKeepTransitions()
Description
This function is a ITransitionMgr_GetProperty shortcut used to get the Keep Transitions property mode of the manager. This mode is used to determine what to do with transitions once they are stopped or completed.
Params
pif
[]:
[in] Pointer to the ITransitionMgr interface object.
pnVal
[]:
[out] Pointer to integer to hold the property's value.
Prototype
  •    int ITransitionMgr_GetKeepTransitions(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
Comments
KeepTransitions can be set to the following values: ITransitionMgr_PVAL_KEEP_TRANSITIONS_OFF - Transitions are released once they are stopped from the manager or have completed. ITransitionMgr_PVAL_KEEP_TRANSITIONS_ON - Transition are kept in a backup queue when stopped or completed. Note that an active manager cannot be set to keep transitions.