GetFinalIntegerValue Method

IUIAnimationVariable::GetFinalIntegerValue method

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

finalValue [out]

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

Minimum supported client

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

Minimum supported server

None supported

Header

UIAnimation.h

IDL

UIAnimation.idl

DLL

UIAnimation.dll

See also

IUIAnimationVariable
IUIAnimationVariable::SetRoundingMode
IUIAnimationVariable::GetIntegerValue
IUIAnimationVariable::GetPreviousIntegerValue
IUIAnimationVariable::GetFinalValue
IUIAnimationVariable::SetLowerBound
IUIAnimationVariable::SetUpperBound

 

 

Show:
© 2016 Microsoft