L_DispContainerStopAnimation

Summary

Stops the animation of the specific cell(s).

Syntax

L_LTIVW_API L_INT L_DispContainerStopAnimation(hCellWnd, uFlags)

Parameters

L_HWND hCellWnd

A handle to the window that represents the cell on which the function's effect will be applied.

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

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

Functions

• L_DispContainerCreate
• L_DispContainerDestroy
• L_DispContainerStartAnimation
• L_DispContainerGetAnimationProperties
• L_DispContainerSetAnimationProperties
• L_DispContainerIsCellAnimated

Topics

• Implementing Animation
• Image Viewer Functions: Implementing Animation

Example

This function stops the animation the specific cell.

L_INT DispContainerStopAnimationExample(HDISPCONTAINER hCon, L_INT nCellIndex) 
{ 
   if (nCellIndex < 0 || nCellIndex > L_DispContainerGetCellCount(hCon, 0)) 
      return ERROR_INV_PARAMETER; 
 
   HWND hCellWnd = L_DispContainerGetCellWindowHandle(hCon, nCellIndex, 0); 
 
   if (!L_DispContainerIsCellAnimated(hCellWnd, 0)) 
      L_DispContainerStopAnimation(hCellWnd, 0); 
 
   return SUCCESS; 
}