LImageViewerCell::StopAnimation

#include "ltwrappr.h"

L_INT LImageViewerCell::StopAnimation(uFlags)

L_UINT uFlags;

/* reserved for future use */

Stops the animation of the specific cell(s).

Parameter

Description

uFlags

Flags that determine whether to apply the feature on the one cell only, or more than one cell. This value can only be used when the cell is attached to the LImageViewer through the function LImageViewer::InsertCell. Possible values are:

 

Value

Meaning

 

CELL_APPLYTOTHIS

[0x00000000] Apply the feature to this cell only.

 

CELL_APPLYTOALL

[0x10000000] Apply the feature to all the cells in the Image Viewer.

 

CELL_APPLYTOSELECTED

[0x20000000] Apply the feature to the selected cells in the Image Viewer.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

To start the animation, call the LImageViewerCell::StartAnimation function.

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

To change the animation properties of a specific cell, call the LImageViewerCell::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, LImageViewerCell::StartAnimation, LImageViewerCell::GetAnimationProperties, LImageViewerCell::SetAnimationProperties, LImageViewerCell::IsCellAnimated.

Topics:

Image Viewer Functions: Implementing Animation

 

Implementing Animation

Example

For an example, refer to LImageViewerCell::StartAnimation.