IUIAnimationManager2::FinishAllStoryboards method (uianimation.h)
Finishes all active storyboards within the specified time interval.
Syntax
HRESULT FinishAllStoryboards(
[in] UI_ANIMATION_SECONDS completionDeadline
);
Parameters
[in] completionDeadline
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
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 8, Windows 7 and Platform Update for Windows 7 [desktop apps | UWP apps] |
| Minimum supported server | None supported |
| Target Platform | Windows |
| Header | uianimation.h |
| DLL | UIAnimation.dll |
See also
IUIAnimationStoryboard::Finish