IUIAnimationManager2::SetConcludePriorityComparison method (uianimation.h)

Article
02/22/2024

Sets the priority comparison handler that determines whether a scheduled storyboard can be concluded.

Syntax

HRESULT SetConcludePriorityComparison(
  [in, optional] IUIAnimationPriorityComparison2 *comparison
);

Parameters

[in, optional] comparison

The priority comparison handler for conclusion. The specified object must implement the IUIAnimationPriorityComparison2 interface or be NULL. See Remarks for more info.

Return value

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

Remarks

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

A scheduled storyboard can be concluded only if it contains a loop with a repetition count of UI_ANIMATION_REPEAT_INDEFINITELY and the priority comparison object registered with this method returns S_OK. If the storyboard is concluded, the current repetition of the loop completes, and the rest of the storyboard then plays.

Passing NULL for the comparison 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