In This Topic ▼

L_DispContainerSetAnimationStoppedCallBack

Summary

Sets a callback function, which will be fired if the control animation has stopped.

Syntax

#include "ltivw.h"

L_LTIVW_API L_INT EXT_FUNCTION L_DispContainerSetAnimationStoppedCallBack(hCellWnd, pfnCallBack, pUserData)

Parameters

L_HWND hCellWnd

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

DISPCONTAINERANIMATIONSTOPPEDCALLBACK pfnCallBack

Pointer to a callback function, which will be fired every time the animation, has been stopped using the function L_DispContainerStopAnimation. The callback function must adhere to the function prototype described in DISPCONTAINERANIMATIONSTOPPEDCALLBACK.

LPVOID pUserData

Void pointer that you can use to pass one or more additional parameters that the callback function needs.

To use this feature, assign a value to a variable or create a structure that contains as many fields as you need. Then, in this parameter, pass the address of the variable or structure, casting it to L_VOID *. The callback function, which receives the address in its own pUserData parameter, can cast it to a pointer of the appropriate data type to access your variable or structure. If the additional parameters are not needed, you can pass NULL in this parameter.

Returns

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

Comments

To get the current animation stopped callback function call the L_DispContainerGetAnimationStoppedCallBack function.
The cell(s) must contain multiple frames.
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.
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.