Collapse All Expand All

LAnimationWindow::DoEvents

#include "ltwrappr.h"

L_BOOL LAnimationWindow::DoEvents(pbCanceled=NULL, uVKey=VK_ESCAPE) const

L_BOOL * pbCanceled;	/* pointer to a boolean flag */
L_UINT uVKey;	/* virtual key code to be used as an escape key */

Allows events to take action while animation playback is in progress.

Parameter	Description
pbCanceled	Pointer to boolean flag. This parameter can be NULL.
uVKey	Virtual key code to be used as an escape key.

Returns

TRUE	WM_QUIT message received.
FALSE	Otherwise.

Comments

This function passes control to the operating system. Control is returned after the operating system has finished processing the events in its queue (messages).

DoEvents is most useful for allowing a user to cancel a playback after it has started.

If pbCanceled is not NULL, on return it will contain TRUE if the user has pressed the escape key during message processing.

If the DoEvents captured the WM_QUIT message, the return value is TRUE, otherwise it is FALSE.

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.

See Also

Functions:	LAnimationWindow::LAnimationWindow, LAnimationWindow::IsPlaying, LAnimationWindow::PlayAnimation, Class Members
Topics:	Implementing Animation

Example

For an example, refer to LAnimationWindow::PlayAnimation.