Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IUIAnimationVariableIntegerChangeHandler2::OnIntegerValueChanged method

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

storyboard [in]

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

variable [in]

The animation variable that has been updated.

newValue [in]

The new integer value of the animation variable.

Note  The rounding mode for an animation variable is specified using the SetRoundingMode method.

previousValue [in]

The previous integer value of the animation variable.

Note  The rounding mode for an animation variable is specified using the SetRoundingMode method.

cDimension [in]

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:

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_IUIAnimationVariableIntegerChangeHandler2 is defined as 829B6CF1-4F3A-4412-AE09-B243EB4C6B58

See also

IUIAnimationVariableIntegerChangeHandler2
SetVariableIntegerChangeHandler
IUIAnimationVariableChangeHandler2
OnValueChanged
UI_ANIMATION_ROUNDING_MODE

 

 

Community Additions

Show:
© 2014 Microsoft