IUIAnimationStoryboard::Schedule-Methode (uianimation.h)

Artikel
08/26/2023

Weist das Storyboard an, sich selbst für die Wiedergabe zu planen.

Syntax

HRESULT Schedule(
  [in]            UI_ANIMATION_SECONDS           timeNow,
  [out, optional] UI_ANIMATION_SCHEDULING_RESULT *schedulingResult
);

Parameter

[in] timeNow

Die aktuelle Zeit.

[out, optional] schedulingResult

Das Ergebnis der Terminplanungsanforderung. Dieser Parameter kann von Aufrufen dieser Methode weggelassen werden.

Rückgabewert

Wenn die Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben. Eine Liste der Fehlercodes finden Sie unter Fehlercodes für die Windows-Animation .

Hinweise

Diese Methode weist ein Storyboard an, um zu versuchen, sich selbst zum Spielzeitplan für Storyboards hinzuzufügen. Die folgenden Regeln gelten:

Wenn keine Storyboards zur Wiedergabe derselben Animationsvariablen vorhanden sind, ist der Versuch erfolgreich, und das Storyboard beginnt sofort mit der Wiedergabe.
Wenn das Storyboard Priorität hat, konfliktierende Storyboards abzubrechen, zu kürzen, abzuschließen oder zu komprimieren, ist der Versuch, einen Zeitplan zu planen, erfolgreich, und das Storyboard beginnt so schnell wie möglich mit der Wiedergabe.
Wenn das Storyboard keine Priorität hat, schlägt der Versuch fehl, und der schedulingResult-Parameter ist auf UI_ANIMATION_SCHEDULING_INSUFFICIENT_PRIORITY festgelegt.

Wenn diese Methode von einem Handler für OnStoryboardStatusChanged-Ereignisse aufgerufen wird, wird der schedulingResult-Parameter auf UI_ANIMATION_SCHEDULING_DEFERRED festgelegt. Die einzige Möglichkeit, um festzustellen, ob das Storyboard erfolgreich geplant ist, besteht darin, einen Storyboard-Ereignishandler festzulegen und zu überprüfen, ob die status des Storyboards jemals UI_ANIMATION_STORYBOARD_INSUFFICIENT_PRIORITY wird.

Es ist möglich, ein Storyboard wiederzuverwenden, indem Schedule erneut aufgerufen wird, nachdem die status UI_ANIMATION_STORYBOARD_READY erreicht hat. Ein Versuch, ein Storyboard zu planen, wenn es sich in einem anderen Zustand als UI_ANIMATION_STORYBOARD_BUILDING oder UI_ANIMATION_STORYBOARD_READY befindet, schlägt fehl, und schedulingResult ist auf UI_ANIMATION_SCHEDULING_ALREADY_SCHEDULED festgelegt.

Beispiele

Im folgenden Beispiel wird die aktuelle Uhrzeit abgerufen und das Storyboard geplant. Ein weiteres Beispiel finden Sie unter Planen eines Storyboards.

// Get the current time and schedule the storyboard
UI_ANIMATION_SECONDS secondsNow;
hr = m_pAnimationTimer->GetTime(
    &secondsNow
    );
if (SUCCEEDED(hr))
{
    UI_ANIMATION_SCHEDULING_RESULT schedulingResult;
    hr = pStoryboard->Schedule(
        secondsNow,
        &schedulingResult
        );
    if (SUCCEEDED(hr))
    {
        if (schedulingResult == UI_ANIMATION_SCHEDULING_SUCCEEDED)
        {
            ...
        }
        else
        {
            ...
        }
    }
}

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 7, Windows Vista und Platform Update für Windows Vista [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Nicht unterstützt
Zielplattform	Windows
Kopfzeile	uianimation.h
DLL	UIAnimation.dll