IUIAnimationVariableChangeHandler2::OnValueChanged method (uianimation.h)

Article
10/13/2021

Handles events that occur when the value of an animation variable changes in the specified dimension.

Syntax

HRESULT OnValueChanged(
  [in] IUIAnimationStoryboard2 *storyboard,
  [in] IUIAnimationVariable2   *variable,
  [in] DOUBLE                  *newValue,
  [in] DOUBLE                  *previousValue,
  [in] UINT                    cDimension
);

Parameters

[in] storyboard

The storyboard that is animating the animation variable specified by the variable parameter.

[in] variable

The animation variable that has been updated.

[in] newValue

The new value of the animation variable.

[in] previousValue

The previous value of the animation variable.

[in] cDimension

The dimension in which the value of the animation variable changed.

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

This method receives updates as DOUBLE values.
To receive updates as INT32 values, use the IUIAnimationVariableIntegerChangeHandler2::OnIntegerValueChanged method.

By default, a call made in a callback method to any other animation method results in the call failing and returning UI_E_ILLEGAL_REENTRANCY. However, there are exceptions to this default. The following methods can be successfully called from IUIAnimationVariableChangeHandler2::OnValueChanged:

Requirements

Requirement	Value
Minimum supported client	Windows 8, Windows 7 and Platform Update for Windows 7 [desktop apps \| UWP apps]
Minimum supported server	None supported
Target Platform	Windows
Header	uianimation.h
DLL	UIAnimation.dll