IUIAnimationStoryboard2::GetStatus method

Gets the status of the storyboard.

Syntax


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

Parameters

status [out, retval]

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

Minimum supported client

Windows 8, Windows 7 and Platform Update for Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

None supported [desktop apps | Windows Store apps]

Header

UIAnimation.h

IDL

UIAnimation.idl

DLL

UIAnimation.dll

IID

IID_IUIAnimationStoryboard2 is defined as AE289CD2-12D4-4945-9419-9E41BE034DF2

See also

IUIAnimationStoryboard2
IUIAnimationStoryboardEventHandler2::OnStoryboardStatusChanged
UI_ANIMATION_STORYBOARD_STATUS

 

 

Community Additions

ADD
Show:
© 2014 Microsoft