IUIAnimationTimer::SetTimerEventHandler method

Specifies a timer event handler.

Syntax

HRESULT SetTimerEventHandler(
  [in, optional] IUIAnimationTimerEventHandler *handler
);

Parameters

handler [in, optional]

A timer event handler. The specified object must implement the IUIAnimationTimerEventHandler interface or be NULL. See Remarks.

Return value

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. See Windows Animation Error Codes for a list of error codes.

Remarks

Timing events include the OnPreUpdate, OnPostUpdate, and OnRenderingTooSlow methods of the IUIAnimationTimerEventHandler interface.

Passing NULL for the handler parameter causes Windows Animation to release its reference to any handler object you passed in earlier. This technique can be essential for breaking reference cycles without having to call the IUIAnimationManager::Shutdown method.

Examples

For an example, see Update the Animation Manager and Draw Frames.

Requirements

See also

IUIAnimationTimer

IUIAnimationTimer::SetFrameRateThreshold

IUIAnimationTimer::SetTimerUpdateHandler

IUIAnimationTimerEventHandler