IUIAnimationVariable::SetVariableChangeHandler method (uianimation.h)

Article
02/22/2024

Specifies a variable change handler. This handler is notified of changes to the value of the animation variable.

Syntax

HRESULT SetVariableChangeHandler(
  [in, optional] IUIAnimationVariableChangeHandler *handler
);

Parameters

[in, optional] handler

A variable change handler.

The specified object must implement the IUIAnimationVariableChangeHandler interface or be NULL.

See Remarks.

Return value

If the 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

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

Requirements

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