Skip to main content
IUIAnimationStoryboard2::SetStoryboardEventHandler method

Specifies a handler for storyboard events.

Syntax


HRESULT SetStoryboardEventHandler(
  [in, optional, unique] IUIAnimationStoryboardEventHandler2 *handler,
  [in]                   BOOL                                fRegisterStatusChangeForNextAnimationEvent,
  [in]                   BOOL                                fRegisterUpdateForNextAnimationEvent
);

Parameters

handler [in, optional]

The handler that Windows Animation should call whenever storyboard status and update events occur. The specified object must implement the IUIAnimationStoryboardEventHandler2 interface or be NULL. See Remarks for more info.

fRegisterStatusChangeForNextAnimationEvent [in]

If TRUE, registers the OnStoryboardStatusChanged event and includes those events in IUIAnimationManager2::EstimateNextEventTime, which estimates the time interval until the next animation event. No default value.

fRegisterUpdateForNextAnimationEvent [in]

If TRUE, registers the OnStoryboardUpdated event and includes those events in IUIAnimationManager2::EstimateNextEventTime, which estimates 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

Minimum supported client

Windows 8, Windows 7 and Platform Update for Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

None supported

Header

UIAnimation.h

IDL

UIAnimation.idl

DLL

UIAnimation.dll

IID

IID_IUIAnimationStoryboard2 is defined as AE289CD2-12D4-4945-9419-9E41BE034DF2

See also

IUIAnimationStoryboard2
IUIAnimationStoryboardEventHandler2