Edit

IUIAnimationStoryboard::GetStatus method (uianimation.h)

  • Article

Gets the status of the storyboard.

Syntax

HRESULT GetStatus(
  [out] UI_ANIMATION_STORYBOARD_STATUS *status
);

Parameters

[out] status

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

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

IUIAnimationStoryboard

IUIAnimationStoryboardEventHandler::OnStoryboardStatusChanged

UI_ANIMATION_STORYBOARD_STATUS