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.IUIAnimationStoryboard2.Schedule

IUIAnimationStoryboard2::Schedule (uianimation.h)

Directs the storyboard to schedule itself for play. (IUIAnimationStoryboard2.Schedule)

IUIAnimationStoryboard2 interface [Windows Animation]

Schedule method

IUIAnimationStoryboard2.Schedule

IUIAnimationStoryboard2::Schedule

Schedule

Schedule method [Windows Animation]

IUIAnimationStoryboard2 interface

uianimation.iuianimationstoryboard2_schedule

uianimation/IUIAnimationStoryboard2::Schedule

uianimation\iuianimationstoryboard2_schedule.htm

UIAnimation

9F20AE4A-F693-4DDA-90F4-FCCA5291208B

12/05/2018

IUIAnimationStoryboard2 interface [Windows Animation],Schedule method, IUIAnimationStoryboard2.Schedule, IUIAnimationStoryboard2::Schedule, Schedule, Schedule method [Windows Animation], Schedule method [Windows Animation],IUIAnimationStoryboard2 interface, uianimation.iuianimationstoryboard2_schedule, uianimation/IUIAnimationStoryboard2::Schedule

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

IUIAnimationStoryboard2::Schedule

uianimation/IUIAnimationStoryboard2::Schedule

c++

APIRef

kbSyntax

COM

UIAnimation.dll

IUIAnimationStoryboard2.Schedule

IUIAnimationStoryboard2::Schedule

-description

Directs the storyboard to schedule itself for play.

-parameters

-param timeNow [in]

The current time.

-param schedulingResult [out, optional]

The result of the scheduling request. You can omit this parameter from calls to this method.

-returns

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

-remarks

This method directs a storyboard to try to add itself to the schedule of playing storyboards, using these rules:

If there are no playing storyboards animating any of the same animation variables, the attempt succeeds and the storyboard starts playing immediately.
If the storyboard has priority to cancel, trim, conclude, or compress conflicting storyboards, the attempt to schedule succeeds and the storyboard starts playing as soon as possible.
If the storyboard does not have priority, the attempt fails and the schedulingResult parameter is set to UI_ANIMATION_SCHEDULING_INSUFFICIENT_PRIORITY.

If this method is called from a handler for OnStoryboardStatusChanged events, the schedulingResult parameter is set to UI_ANIMATION_SCHEDULING_DEFERRED. The only way to determine whether the storyboard is successfully scheduled is to set a storyboard event handler and check whether the storyboard's status ever becomes UI_ANIMATION_SCHEDULING_INSUFFICIENT_PRIORITY.

It is possible to reuse a storyboard by calling Schedule again after its status has reached UI_ANIMATION_STORYBOARD_READY. An attempt to schedule a storyboard when it is in any state other than UI_ANIMATION_STORYBOARD_BUILDING or UI_ANIMATION_STORYBOARD_READY fails, and schedulingResult is set to UI_ANIMATION_SCHEDULING_ALREADY_SCHEDULED.