IUIAnimationStoryboard2::Finish method (uianimation.h)
Finishes the storyboard within the specified time, compressing the storyboard if necessary.
Syntax
HRESULT Finish(
UI_ANIMATION_SECONDS completionDeadline
);
Parameters
completionDeadline
The maximum amount of time that the storyboard can use to finish playing.
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
This method has no effect on storyboard events. Events continue to be raised as expected while the storyboard plays.
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
IUIAnimationManager2::FinishAllStoryboards
IUIAnimationStoryboard2::Abandon