IUIAnimationVariable2::SetVariableChangeHandler method

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

Syntax


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

Parameters

handler [in, optional]

The handler for changes to the value of the animation variable. This parameter can be NULL.

fRegisterForNextAnimationEvent [in]

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

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_IUIAnimationVariable2 is defined as 4914B304-96AB-44d9-9E77-D5109B7E7466

See also

IUIAnimationVariable2
IUIAnimationVariableChangeHandler2
IUIAnimationVariable2::SetVariableIntegerChangeHandler

 

 

Community Additions

ADD
Show:
© 2014 Microsoft