Skip to content

Latest commit

 

History

History
92 lines (65 loc) · 4.62 KB

nf-uianimation-iuianimationmanager-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.IUIAnimationManager.SetConcludePriorityComparison
IUIAnimationManager::SetConcludePriorityComparison (uianimation.h)
Sets the priority comparison handler to be called to determine whether a scheduled storyboard can be concluded.
IUIAnimationManager interface [Windows Animation]
SetConcludePriorityComparison method
IUIAnimationManager.SetConcludePriorityComparison
IUIAnimationManager::SetConcludePriorityComparison
SetConcludePriorityComparison
SetConcludePriorityComparison method [Windows Animation]
SetConcludePriorityComparison method [Windows Animation]
IUIAnimationManager interface
uianimation.iuianimationmanager_setconcludeprioritycomparison
uianimation/IUIAnimationManager::SetConcludePriorityComparison
uianimation\iuianimationmanager_setconcludeprioritycomparison.htm
UIAnimation
00a3d7e4-7ad2-46a8-a9c2-0e725005c00b
12/05/2018
IUIAnimationManager interface [Windows Animation],SetConcludePriorityComparison method, IUIAnimationManager.SetConcludePriorityComparison, IUIAnimationManager::SetConcludePriorityComparison, SetConcludePriorityComparison, SetConcludePriorityComparison method [Windows Animation], SetConcludePriorityComparison method [Windows Animation],IUIAnimationManager interface, uianimation.iuianimationmanager_setconcludeprioritycomparison, uianimation/IUIAnimationManager::SetConcludePriorityComparison
uianimation.h
Windows
Windows 7, Windows Vista and Platform Update for Windows Vista [desktop apps \| UWP apps]
None supported
UIAnimation.idl
UIAnimation.dll
Windows
19H1
IUIAnimationManager::SetConcludePriorityComparison
uianimation/IUIAnimationManager::SetConcludePriorityComparison
c++
APIRef
kbSyntax
COM
UIAnimation.dll
IUIAnimationManager.SetConcludePriorityComparison

IUIAnimationManager::SetConcludePriorityComparison

-description

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

-parameters

-param comparison [in, optional]

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

-returns

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.

-see-also

IUIAnimationManager

IUIAnimationManager::SetCancelPriorityComparison

IUIAnimationManager::SetCompressPriorityComparison

IUIAnimationManager::SetTrimPriorityComparison

IUIAnimationPriorityComparison