L_DispContainerGetAnimationProperties

Summary

Retrieves the current animation properties of the specified cell.

Syntax

L_LTIVW_API L_INT L_DispContainerGetAnimationProperties(hCellWnd, pDisAnimationProps, uFlags)

Parameters

L_HWND hCellWnd

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

pDISPANIMATIONPROPS pDisAnimationProps

Pointer to a DISPANIMATIONPROPS structure to be updated with the current animation properties of the specific cell.

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

Comments

To change the animation properties of a cell, call the L_DispContainerSetAnimationProperties function.

Before calling L_DispContainerGetAnimationProperties the user should:

1. Declare a variable of type DISPANIMATIONPROPS.
2. Pass a pointer to the DISPANIMATIONPROPS structure to L_DispContainerGetAnimationProperties as the pDisAnimationProps parameter.

For more information on the available animation properties, refer to the DISPANIMATIONPROPS structure.

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_DispContainerStopAnimation
• L_DispContainerSetAnimationProperties
• L_DispContainerIsCellAnimated

Topics

• Implementing Animation
• Image Viewer Functions: Implementing Animation

Example

For an example, refer to L_DispContainerStartAnimation.