IUIAnimationStoryboard2::SetLongestAcceptableDelay method

Sets the longest acceptable delay before the scheduled storyboard begins.

Syntax

HRESULT SetLongestAcceptableDelay(
  [in] UI_ANIMATION_SECONDS delay
);

Parameters

delay [in]

The longest acceptable 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 this method, the delay value set by calling the IUIAnimationManager2::SetDefaultLongestAcceptableDelay method, or 0.0 if neither of these methods has been called.

Use IUIAnimationStoryboard2::SetSkipDuration to start a storyboard animation at a specified offset instead of delaying the start of a storyboard.

Requirements

See also

IUIAnimationStoryboard2

SetSkipDuration