Export (0) Print
Expand All

IUIAnimationStoryboard::SetTag method

Sets the tag for the storyboard.

Syntax


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

Parameters

object [in, optional]

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

id [in]

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_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

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::GetTag

 

 

Community Additions

ADD
Show:
© 2014 Microsoft