IUIAnimationManager::SetCancelPriorityComparison method (uianimation.h)

Sets the priority comparison handler to be called to determine whether a scheduled storyboard can be canceled.


HRESULT SetCancelPriorityComparison(
  [in, optional] IUIAnimationPriorityComparison *comparison


[in, optional] comparison

The priority comparison handler for cancelation.

The specified object must implement the IUIAnimationPriorityComparison 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.


Setting a priority comparison handler with this method enables the application to indicate when scheduling conflicts can be resolved by canceling storyboards.

A scheduled storyboard can be canceled only if it has not started playing and the priority comparison object registered with this method returns S_OK. Canceled storyboards are completely removed from the schedule.

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


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

See also