L_DispContainerGetAnimationProperties

#include "ltivw.h"

L_LTIVW_API L_INT L_DispContainerGetAnimationProperties(hCon, nCellIndex, pDisAnimationProps, uFlags)

HDISPCONTAINER hCon;

/* handle to the container */

L_INT nCellIndex;

/* index of a cell */

pDISPANIMATIONPROPS pDisAnimationProps;

/* pointer to a DISPANIMATIONPROPS structure */

L_UINT uFlags;

/* reserved for future use */

Retrieves the current animation properties of the specified cell. 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 for which to retrieve the animation properties.

pDisAnimationProps

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

uFlags

Reserved for future use. Pass 0.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

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.