IUIAnimationStoryboard::SetTag method (uianimation.h)

Article
02/22/2024

Sets the tag for the storyboard.

Syntax

HRESULT SetTag(
  [in, optional] IUnknown *object,
  [in]           UINT32   id
);

Parameters

[in, optional] object

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

[in] 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_STORYBOARD_ACTIVE	The storyboard is currently in the schedule.

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.

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