Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Finishes the storyboard within the specified time, compressing the storyboard if necessary.
Syntax
HRESULT Finish(
[in] UI_ANIMATION_SECONDS completionDeadline
);
Parameters
[in] completionDeadline
The maximum amount of time that the storyboard can use to finish playing.
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
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 7, Windows Vista and Platform Update for Windows Vista [desktop apps | UWP apps] |
| Minimum supported server | None supported |
| Target Platform | Windows |
| Header | uianimation.h |
| DLL | UIAnimation.dll |
See also
IUIAnimationManager::FinishAllStoryboards
IUIAnimationStoryboard::Abandon