IUIAnimationVariable2::SetVariableIntegerChangeHandler method (uianimation.h)

Specifies a handler for changes to the integer value of the animation variable.

Syntax

HRESULT SetVariableIntegerChangeHandler(
  [in, optional] IUIAnimationVariableIntegerChangeHandler2 *handler,
  [in]           BOOL                                      fRegisterForNextAnimationEvent
);

Parameters

[in, optional] handler

A pointer to the handler for changes to the integer value of the animation variable. This parameter can be NULL.

[in] fRegisterForNextAnimationEvent

If TRUE, specifies that the EstimateNextEventTime method will incorporate handler into its estimate of the time interval until the next animation event. No default value.

Return value

Returns S_OK if successful; otherwise an HRESULT error code. See Windows Animation Error Codes for a list of error codes.

Remarks

Passing NULL for the handler parameter causes Windows Animation to release its reference to any handler object that you passed in earlier. This technique can be essential for breaking reference cycles without having to call the Shutdown method.

IUIAnimationVariableIntegerChangeHandler2::OnIntegerValueChanged is called only if the rounded value has changed since the last update.

Requirements

See also

IUIAnimationVariable2

IUIAnimationVariableChangeHandler2