IUIAnimationTransition::GetDuration method (uianimation.h)

Article
02/22/2024

Gets the duration of the transition.

Syntax

HRESULT GetDuration(
  [out] UI_ANIMATION_SECONDS *duration
);

Parameters

[out] duration

The duration of the transition, in seconds.

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_DETERMINED	The requested value for the duration cannot be determined.
UI_E_STORYBOARD_ACTIVE	The storyboard for this transition is currently in the schedule.

Remarks

An application should typically call the IUIAnimationTransition::IsDurationKnown method before calling this method. This method should not be called when the storyboard to which the transition has been added is scheduled or playing.

Examples

The following shows how to get the duration of a transition.

hr = pTransition->IsDurationKnown();
if (SUCCEEDED(hr))
{
    bool fDurationKnown = (hr == S_OK); 
    if (fDurationKnown)
    {
        UI_ANIMATION_SECONDS duration;
        hr = pTransition->GetDuration(&duration);
        if (SUCCEEDED(hr))
        {        
            ...
        }
    }
    else
    {
        ...
    }
}

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

Share via