IUIAnimationStoryboard2::GetStatus method (uianimation.h)

Gets the status of the storyboard.

Syntax

HRESULT GetStatus(
  [out, retval] UI_ANIMATION_STORYBOARD_STATUS *status
);

Parameters

[out, retval] status

The storyboard status.

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

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

See also

IUIAnimationStoryboard2

IUIAnimationStoryboardEventHandler2::OnStoryboardStatusChanged

UI_ANIMATION_STORYBOARD_STATUS