IUIAnimationVariable2::SetVariableChangeHandler method (uianimation.h)

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

Syntax

HRESULT SetVariableChangeHandler(
  [in, optional] IUIAnimationVariableChangeHandler2 *handler,
  [in]           BOOL                               fRegisterForNextAnimationEvent
);

Parameters

[in, optional] handler

The handler for changes to the 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 IUIAnimationManager2::Shutdown method.

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

See also

IUIAnimationVariable2

IUIAnimationVariable2::SetVariableIntegerChangeHandler

IUIAnimationVariableChangeHandler2