Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IUIAnimationManager::SetConcludePriorityComparison method

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

Syntax


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

Parameters

comparison [in, optional]

The priority comparison handler for conclusion. 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.

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 reminder of the storyboard then plays.

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

Minimum supported client

Windows 7, Windows Vista and Platform Update for Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

None supported

Header

UIAnimation.h

IDL

UIAnimation.idl

DLL

UIAnimation.dll

See also

IUIAnimationManager
IUIAnimationPriorityComparison
IUIAnimationManager::SetCancelPriorityComparison
IUIAnimationManager::SetCompressPriorityComparison
IUIAnimationManager::SetTrimPriorityComparison

 

 

Show:
© 2017 Microsoft