IUIAnimationStoryboard2::GetTag method

Gets the tag for a storyboard.

Syntax


HRESULT GetTag(
  [out, optional] IUnknown **object,
  [out, optional] UINT32   *id
);

Parameters

object [out, optional]

The object portion of the tag.

id [out, optional]

The identifier portion of the tag.

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.

Return codeDescription
UI_E_VALUE_NOT_SET

The storyboard tag was not set.

 

Remarks

A tag is a pairing of an integer identifier (id) with a COM object (object); it can be used by an application to identify a storyboard.

This method can return the identifier, the object, or both portions of the 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

Header

UIAnimation.h

IDL

UIAnimation.idl

DLL

UIAnimation.dll

IID

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

See also

IUIAnimationStoryboard2
IUIAnimationManager2::GetStoryboardFromTag
IUIAnimationStoryboard2::SetTag

 

 

Show: