IUIAnimationStoryboard2::GetTag method (uianimation.h)

Gets the tag for a storyboard.

Syntax

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

Parameters

[out, optional] object

The object portion of the tag.

[out, optional] id

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 code Description
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

Requirement Value
Minimum supported client Windows 8, Windows 7 and Platform Update for Windows 7 [desktop apps | UWP apps]
Minimum supported server None supported
Target Platform Windows
Header uianimation.h
DLL UIAnimation.dll

See also

IUIAnimationManager2::GetStoryboardFromTag

IUIAnimationStoryboard2

IUIAnimationStoryboard2::SetTag