Export (0) Print
Expand All

IUIAnimationStoryboard::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 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.

Return codeDescription
UI_E_VALUE_NOT_SET

The storyboard's 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.

The parameters are optional so that the method can return both portions of the tag, or just the identifier or object portion.

Requirements

Minimum supported client

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

Minimum supported server

None supported [desktop apps | Windows Store apps]

Header

UIAnimation.h

IDL

UIAnimation.idl

DLL

UIAnimation.dll

See also

IUIAnimationManager::GetStoryboardFromTag
IUIAnimationStoryboard
IUIAnimationStoryboard::SetTag

 

 

Community Additions

ADD
Show:
© 2015 Microsoft