IUIAnimationVariable::GetFinalIntegerValue method (uianimation.h)

Article
10/13/2021

Gets the final value of the animation variable as an integer.
This is the value after all currently scheduled animations have completed.

Syntax

HRESULT GetFinalIntegerValue(
  [out] INT32 *finalValue
);

Parameters

[out] finalValue

The final value of the animation variable, converted to an INT32 value.

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 final value of the animation variable cannot be determined at this time.

Remarks

To specify the rounding mode to be used when converting the value, use the IUIAnimationVariable::SetRoundingMode method.

The result can also be affected by the lower and upper bounds determined by IUIAnimationVariable::SetLowerBound and IUIAnimationVariable::SetUpperBound, respectively.

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