In This Topic ▼

L_DispContainerGetAnimationStartedCallBack

Summary

Gets a callback function, which will be fired if the control animation has been started.

Syntax

#include "ltivw.h"

L_LTIVW_API L_INT EXT_FUNCTION L_DispContainerGetAnimationStartedCallBack(hCellWnd, ppfnCallBack, ppUserData)

Parameters

L_HWND hCellWnd

A handle to the window that represents the Medical Viewer Cell.

DISPCONTAINERANIMATIONSTARTEDCALLBACK * ppfnCallBack

Pointer to a pointer to a callback function to be updated with the last animation started callback function set using the L_DispContainerSetAnimationStartedCallBack function.

LPVOID * ppUserData

Void pointer to be updated with the user defined data associated with the tag callback. If you are not interested in the user-defined data, pass NULL for this parameter.

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

To set the current animation started callback function call the L_DispContainerSetAnimationStartedCallBack function.
To set the current animation stopped callback function call the L_DispContainerSetAnimationStoppedCallBack function.
To get the current animation stopped callback function call the L_DispContainerGetAnimationStoppedCallBack function.
The cell(s) must contain multiple frames or the animation will scroll through a single frame, which will make the user think that the animation is not working.
To start the animation, call the L_DispContainerStartAnimation function.
To stop the animation, call the L_DispContainerStopAnimation 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 has been started.
The user also can change the cell properties, and can apply various actions while the animation is running.
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.