L_DispContainerStopAnimation
#include "ltivw.h"
L_LTIVW_API L_INT L_DispContainerStopAnimation(hCon, nCellIndex, uFlags)
HDISPCONTAINER hCon; |
/* handle to the container */ |
L_INT nCellIndex; |
/* index of a cell */ |
L_UINT uFlags; |
/* reserved for future use */ |
Stops the animation of the specific cell(s). This function is available only in the Medical Imaging Suite toolkits.
Parameter |
Description |
hCon |
Handle to the container. |
nCellIndex |
A zero-based index of the cell the user wants to stop animating. Pass -1 to apply this effect on all cells. Pass -2 to apply this effect on the selected cells. |
uFlags |
Reserved for future use. Pass 0. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
To start the animation, call the L_DispContainerStartAnimation function.
To check whether the cell is in an animation phase, call the L_DispContainerIsCellAnimated function.
The user can change or retrieve the animation properties even if the animation is started.
To retrieve the animation properties of a specific cell, call the L_DispContainerGetAnimationProperties function.
To change the animation properties of a specific cell, call the L_DispContainerSetAnimationProperties function.
Required DLLs and Libraries
LTIVW For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
See Also
Example
This function stops the animation the specific cell.
L_INT DispContainerStopAnimationExample(HDISPCONTAINER hCon, L_INT nCellIndex) { if (!L_DispContainerIsCellAnimated(hCon, nCellIndex, 0)) L_DispContainerStopAnimation(hCon, nCellIndex, 0); return SUCCESS; }