IUIAnimationVariableIntegerChangeHandler2::OnIntegerValueChanged method (uianimation.h)

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

Syntax

HRESULT OnIntegerValueChanged(
  [in] IUIAnimationStoryboard2 *storyboard,
  [in] IUIAnimationVariable2   *variable,
  [in] INT32                   *newValue,
  [in] INT32                   *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 integer value of the animation variable.

[in] previousValue

The previous integer value of the animation variable.

[in] cDimension

The dimension in which the integer 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 INT32 values.
To receive updates as DOUBLE values, use the OnValueChanged method.

OnIntegerValueChanged events might occur less frequently than OnValueChanged events because values such as 2.2, 2.3, and 2.4 would all be rounded to the same integer.

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 OnIntegerValueChanged:

• GetValue
• GetFinalValue
• GetPreviousValue
• GetIntegerValue
• GetFinalIntegerValue
• GetPreviousIntegerValue
• GetCurrentStoryboard
• GetVariableFromTag
• GetStoryboardFromTag
• GetTag
• GetTag

Requirements

See also

IUIAnimationVariableChangeHandler2

IUIAnimationVariableIntegerChangeHandler2

OnValueChanged

SetVariableIntegerChangeHandler

UI_ANIMATION_ROUNDING_MODE