IUIAnimationStoryboard::GetTag method (uianimation.h)

Article
02/22/2024

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

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