Skip to content

Latest commit

 

History

History
92 lines (65 loc) · 4.62 KB

nf-uianimation-iuianimationmanager2-setconcludeprioritycomparison.md

File metadata and controls

92 lines (65 loc) · 4.62 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:uianimation.IUIAnimationManager2.SetConcludePriorityComparison
IUIAnimationManager2::SetConcludePriorityComparison (uianimation.h)
Sets the priority comparison handler that determines whether a scheduled storyboard can be concluded.
IUIAnimationManager2 interface [Windows Animation]
SetConcludePriorityComparison method
IUIAnimationManager2.SetConcludePriorityComparison
IUIAnimationManager2::SetConcludePriorityComparison
SetConcludePriorityComparison
SetConcludePriorityComparison method [Windows Animation]
SetConcludePriorityComparison method [Windows Animation]
IUIAnimationManager2 interface
uianimation.iuianimationmanager2_setconcludeprioritycomparison
uianimation/IUIAnimationManager2::SetConcludePriorityComparison
uianimation\iuianimationmanager2_setconcludeprioritycomparison.htm
UIAnimation
1BDC9094-6020-4640-B959-59CD6CF48751
12/05/2018
IUIAnimationManager2 interface [Windows Animation],SetConcludePriorityComparison method, IUIAnimationManager2.SetConcludePriorityComparison, IUIAnimationManager2::SetConcludePriorityComparison, SetConcludePriorityComparison, SetConcludePriorityComparison method [Windows Animation], SetConcludePriorityComparison method [Windows Animation],IUIAnimationManager2 interface, uianimation.iuianimationmanager2_setconcludeprioritycomparison, uianimation/IUIAnimationManager2::SetConcludePriorityComparison
uianimation.h
Windows
Windows 8, Windows 7 and Platform Update for Windows 7 [desktop apps \| UWP apps]
None supported
UIAnimation.idl
UIAnimation.dll
Windows
19H1
IUIAnimationManager2::SetConcludePriorityComparison
uianimation/IUIAnimationManager2::SetConcludePriorityComparison
c++
APIRef
kbSyntax
COM
UIAnimation.dll
IUIAnimationManager2.SetConcludePriorityComparison

IUIAnimationManager2::SetConcludePriorityComparison

-description

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

-parameters

-param comparison [in, optional]

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

-returns

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.

-see-also

IUIAnimationManager2

IUIAnimationManager2::SetCancelPriorityComparison

IUIAnimationManager2::SetCompressPriorityComparison

IUIAnimationManager2::SetTrimPriorityComparison

IUIAnimationPriorityComparison