IUIAnimationStoryboard::SetStoryboardEventHandler method

Specifies a handler for storyboard events.

Syntax

HRESULT SetStoryboardEventHandler(
  [in, optional] IUIAnimationStoryboardEventHandler *handler
);

Parameters

handler [in, optional]

The handler to be called whenever storyboard status and update events occur. The specified object must implement the IUIAnimationStoryboardEventHandler 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

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.

Requirements

See also

IUIAnimationStoryboard

IUIAnimationStoryboardEventHandler