In This Topic ▼

LAnimationWindow::PlayAnimation

Summary

Starts an animation playback.

Syntax

#include "ltwrappr.h"

L_INT LAnimationWindow::PlayAnimation()

Returns

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

Comments

This function starts an animation playback. In order to play an animation, you must call LAnimationWindow::Load or LAnimationWindow::SetBitmapList prior to calling this function. You can also pass an LBitmapList object using the constructor.

If the animation is already started, the function will return WRPERR_ANIMATION_ALREADY_STARTED.

If the loaded file is not a valid file, the return value will be WRPERR_ANIMATION_INVALID_FILE.

Required DLLs and Libraries

LTDIS
LTDLG
LTEFX
LTFIL
LTIMG
LTSCR
LTTWN
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

Example

The following example will create an animation, and play it continuously
until the user aborts or closes the program.
The program uses DoEvents to allow the user to stop animation.

L_INT LAnimationWindow_PlayAnimationExample(HWND hWndParent) 
{ 
   L_INT nRet; 
 
   LBase::LoadLibraries(LT_ALL_LEADLIB);  
   //make sure all libraries are loaded 
 
   LAnimationWindow MyAnimation; 
 
   //Set auto loop to TRUE  
 
   MyAnimation.EnableLoop(); 
 
   MyAnimation.SetFileName(MAKE_IMAGE_PATH(TEXT("eye.gif"))); 
    
   nRet = MyAnimation.Load(); 
   if (nRet!=SUCCESS) 
 
   { 
      MessageBox(hWndParent, TEXT("Error loading file!"),TEXT("Sample"), MB_OK|MB_ICONSTOP); 
      return nRet; 
   } 
 
   MyAnimation.CreateWnd(hWndParent,0, WS_VISIBLE|WS_CHILD|WS_BORDER,0,0,300,300); 
 
 
 
   nRet = MyAnimation.PlayAnimation(); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   while (MyAnimation.IsPlaying()) 
 
   { 
 
      L_BOOL bCanceled; 
 
 
 
      L_BOOL bQuit = MyAnimation.DoEvents(&bCanceled); 
 
 
 
      if (bCanceled || bQuit) 
 
      { 
 
         MyAnimation.StopAnimation(); 
 
         break; 
 
      } 
 
   } 
 
   return SUCCESS; 
}