IUIAnimationManager2::SetTrimPriorityComparison method (uianimation.h)

Article
02/22/2024

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

Syntax

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

Parameters

[in, optional] comparison

The priority comparison handler for trimming.

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

A scheduled storyboard can be trimmed only if the priority comparison object registered with this method returns S_OK. If the new storyboard trims the scheduled storyboard, the scheduled storyboard can no longer affect a variable after the new storyboard begins to animate that variable.

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