IUIAnimationStoryboard::GetStatus method
Gets the status of the storyboard.
Syntax
HRESULT GetStatus( [out] UI_ANIMATION_STORYBOARD_STATUS *status );
Parameters
- status [out]
-
The storyboard status.
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
Unless this method is called from a handler for OnStoryboardStatusChanged events, the only values it returns are UI_ANIMATION_STORYBOARD_BUILDING, UI_ANIMATION_STORYBOARD_SCHEDULED, UI_ANIMATION_STORYBOARD_PLAYING, and UI_ANIMATION_STORYBOARD_READY.
Requirements
|
Minimum supported client |
Windows 7, Windows Vista and Platform Update for Windows Vista [desktop apps | Windows Store apps] |
|---|---|
|
Minimum supported server |
None supported |
|
Header |
|
|
IDL |
|
|
DLL |
|
See also
- IUIAnimationStoryboard
- IUIAnimationStoryboardEventHandler::OnStoryboardStatusChanged
- UI_ANIMATION_STORYBOARD_STATUS
Show: