IUIAnimationStoryboard2::Finish method
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
|
Minimum supported client |
Windows 8, Windows 7 and Platform Update for Windows 7 [desktop apps | Windows Store apps] |
|---|---|
|
Minimum supported server |
None supported |
|
Header |
|
|
IDL |
|
|
DLL |
|
|
IID |
IID_IUIAnimationStoryboard2 is defined as AE289CD2-12D4-4945-9419-9E41BE034DF2 |
See also
- IUIAnimationStoryboard2
- IUIAnimationManager2::FinishAllStoryboards
- IUIAnimationStoryboard2::Abandon
- IUIAnimationStoryboard2::Conclude
- IUIAnimationStoryboard2::Schedule