IUIAnimationManager2::GetStoryboardFromTag method

Gets the storyboard with the specified tag.

Syntax


HRESULT GetStoryboardFromTag(
  [in, optional, unique]  IUnknown *object,
  [in]                    UINT32 id,
  [out]                   IUIAnimationStoryboard2 **storyboard
);

Parameters

object [in, optional]

The object portion of the tag. This parameter can be NULL.

id [in]

The identifier portion of the tag.

storyboard [out]

The storyboard that matches the specified tag, or NULL if no match is found.

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

A tag is a pairing of an integer identifier (id) with a COM object (object). An application can use tags to identify animation variables and storyboards. NULL is a valid object component of a tag; therefore, the object parameter can be NULL.

Tags are not necessarily unique; this method returns UI_E_AMBIGUOUS_MATCH if more than one storyboard exists with the specified tag.

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_IUIAnimationManager2 is defined as D8B6F7D4-4109-4d3f-ACEE-879926968CB1

See also

IUIAnimationManager2
IUIAnimationStoryboard2
IUIAnimationStoryboard::GetTag
IUIAnimationStoryboard::SetTag

 

 

Community Additions

ADD
Show:
© 2014 Microsoft