LImageViewer::StopAnimation

#include "ltwrappr.h"

L_INT LImageViewer::StopAnimation(nCellIndex, uFlags)

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

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 LImageViewer::StartAnimation function.

To check whether the cell is in an animation phase, call the LImageViewer::IsCellAnimated 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 LImageViewer::GetAnimationProperties function.

To change the animation properties of a specific cell, call the LImageViewer::SetAnimationProperties 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:

LImageViewer::Create, LImageViewer::Destroy, LImageViewer::StartAnimation, LImageViewer::GetAnimationProperties, LImageViewer::SetAnimationProperties, LImageViewer::IsCellAnimated.

Topics:

Image Viewer Functions: Implementing Animation

 

Implementing Animation

Example

For an example, refer to LImageViewer::StartAnimation.