IUIAnimationManager2::SetDefaultLongestAcceptableDelay method (uianimation.h)

Article
02/22/2024

Sets the default acceptable animation delay. This is the length of time that may pass before storyboards begin.

Syntax

HRESULT SetDefaultLongestAcceptableDelay(
  [in] UI_ANIMATION_SECONDS delay
);

Parameters

[in] delay

The default delay. This parameter can be a positive value, or UI_ANIMATION_SECONDS_EVENTUALLY (-1) to indicate that any finite delay is acceptable.

Return value

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

Remarks

For Windows Animation to schedule a storyboard successfully, the storyboard must begin before the longest acceptable delay has elapsed. Windows Animation determines this delay in the following order: the delay value set by calling IUIAnimationStoryboard::SetLongestAcceptableDelay for this specific storyboard, the delay value set by calling this method, or 0.0 if neither method has been called.

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