IUIAnimationInterpolator2::GetDuration method

Gets the duration of a transition for the given dimension.

Syntax


HRESULT GetDuration(
  [out]  UI_ANIMATION_SECONDS *duration
);

Parameters

duration [out]

The duration of the transition.

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.

Remarks

Windows Animation always calls the IUIAnimationInterpolator2::SetInitialValueAndVelocity method to set the initial value and velocity before calling GetDuration, so a custom interpolator need not check whether the initial value and velocity have been set.

Windows Animation can call SetInitialValueAndVelocity multiple times with different parameters. Interpolators can cache internal state to improve performance, but they must update this cached state each time SetInitialValueAndVelocity is called and ensure that the results of subsequent calls to GetDuration reflect the updated state.

Requirements

Minimum supported client

Windows 8, Windows 7 and Platform Update for Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

None supported [desktop apps | Windows Store apps]

Header

UIAnimation.h

IDL

UIAnimation.idl

DLL

UIAnimation.dll

IID

IID_IUIAnimationInterpolator2 is defined as EA76AFF8-EA22-4a23-A0EF-A6A966703518

See also

IUIAnimationInterpolator2

 

 

Community Additions

ADD
Show:
© 2014 Microsoft