IUIAnimationStoryboard ::Schedule, méthode (uianimation.h)

Article
03/03/2024

Dirige le storyboard pour qu’il se planifie lui-même pour le jeu.

Syntaxe

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

Paramètres

[in] timeNow

L’heure actuelle.

[out, optional] schedulingResult

Résultat de la demande de planification. Ce paramètre peut être omis des appels à cette méthode.

Valeur retournée

Si la méthode réussit, retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT. Pour obtenir la liste des codes d’erreur, consultez Codes d’erreur d’animation Windows .

Remarques

Cette méthode permet à un storyboard de tenter de s’ajouter à la planification de lecture des storyboards. Les règles sont les suivantes :

S’il n’y a aucune lecture de storyboards animant l’une des mêmes variables d’animation, la tentative aboutit et le storyboard commence immédiatement à jouer.
Si le storyboard a la priorité d’annuler, de rogner, de conclure ou de compresser les storyboards en conflit, la tentative de planification réussit et le storyboard commence à jouer dès que possible.
Si le storyboard n’est pas prioritaire, la tentative échoue et le paramètre schedulingResult est défini sur UI_ANIMATION_SCHEDULING_INSUFFICIENT_PRIORITY.

Si cette méthode est appelée à partir d’un gestionnaire pour les événements OnStoryboardStatusChanged , le paramètre schedulingResult est défini sur UI_ANIMATION_SCHEDULING_DEFERRED. La seule façon de déterminer si le storyboard est correctement planifié consiste à définir un gestionnaire d’événements de storyboard et à case activée si le status du storyboard devient jamais UI_ANIMATION_STORYBOARD_INSUFFICIENT_PRIORITY.

Il est possible de réutiliser un storyboard en appelant à nouveau Schedule une fois que son status a atteint UI_ANIMATION_STORYBOARD_READY. Une tentative de planification d’un storyboard lorsqu’il est dans un état autre que UI_ANIMATION_STORYBOARD_BUILDING ou UI_ANIMATION_STORYBOARD_READY échoue, et scheduleResult est défini sur UI_ANIMATION_SCHEDULING_ALREADY_SCHEDULED.

Exemples

L’exemple suivant obtient l’heure actuelle et planifie le storyboard. Pour obtenir un exemple supplémentaire, consultez Planifier un storyboard.

// 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
        {
            ...
        }
    }
}

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 7, Windows Vista et Mise à jour de plateforme pour Windows Vista [applications de bureau \| Applications UWP]
Serveur minimal pris en charge	Aucun pris en charge
Plateforme cible	Windows
En-tête	uianimation.h
DLL	UIAnimation.dll