IUIAnimationManager2::SetManagerEventHandler method

Specifies a handler for animation manager status updates.

Syntax

HRESULT SetManagerEventHandler(
  [in, optional, unique] IUIAnimationManagerEventHandler *handler,
  [in]                   BOOL                            fRegisterForNextAnimationEvent
);

Parameters

handler [in, optional]

The event handler to be called when the status of the animation manager changes. The specified object must implement the IUIAnimationManagerEventHandler interface or be NULL. See Remarks for more info.

fRegisterForNextAnimationEvent [in]

If TRUE, specifies that IUIAnimationManager2::EstimateNextEventTime will incorporate handler into its estimate of the time interval until the next animation event. No default value.

Return value

Returns S_OK if successful; otherwise an HRESULT error code. See Windows Animation Error Codes for a list of error codes.

Remarks

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

Requirements

See also

IUIAnimationManager2

IUIAnimationManagerEventHandler