IUIAnimationManager2::FinishAllStoryboards method

Finishes all active storyboards within the specified time interval.

Syntax

C++
Copy 

HRESULT FinishAllStoryboards(
  [in] UI_ANIMATION_SECONDS completionDeadline
);

Parameters

completionDeadline [in]

The maximum time interval during which all storyboards must be finished.

Return value

If this 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

Calling the FinishAllStoryboards method ensures that all active storyboards finish within the specified completion deadline. If a storyboard is scheduled to play past the deadline, it is compressed.

A storyboard is considered active if a call to the IUIAnimationStoryboard::GetStatus method returns UI_ANIMATION_STORYBOARD_PLAYING or UI_ANIMATION_STORYBOARD_SCHEDULED.

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_IUIAnimationManager2 is defined as D8B6F7D4-4109-4d3f-ACEE-879926968CB1

See also

IUIAnimationManager2
IUIAnimationStoryboard::Finish
IUIAnimationStoryboard::GetStatus
UI_ANIMATION_STORYBOARD_STATUS

 

 

Show: