IUIAnimationStoryboard2::Schedule メソッド (uianimation.h)

ストーリーボードにプレイのスケジュールを設定するように指示します。

構文

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

パラメーター

[in] timeNow

現在の時刻。

[out, optional] schedulingResult

スケジュール要求の結果。 このパラメーターは、このメソッドの呼び出しから省略できます。

戻り値

成功した場合はS_OKを返します。それ以外の場合は HRESULT エラー コード。 エラー コードの一覧については、「 Windows アニメーション エラー コード 」を参照してください。

解説

このメソッドは、次のルールを使用して、ストーリーボードを再生するスケジュールに自分自身を追加するようにストーリーボードに指示します。

  • 同じアニメーション変数のいずれかをアニメーション化するストーリーボードが再生されていない場合、試行は成功し、ストーリーボードはすぐに再生を開始します。
  • ストーリーボードに競合するストーリーボードをキャンセル、トリミング、終了、または圧縮する優先順位がある場合、スケジュールの試行は成功し、ストーリーボードはできるだけ早く再生を開始します。
  • ストーリーボードに優先度がない場合、試行は失敗し、 schedulingResult パラメーターは UI_ANIMATION_SCHEDULING_INSUFFICIENT_PRIORITY に設定されます。
OnStoryboardStatusChanged イベントのハンドラーからこのメソッドが呼び出された場合、schedulingResult パラメーターは UI_ANIMATION_SCHEDULING_DEFERRED に設定されます。 ストーリーボードが正常にスケジュールされているかどうかを判断する唯一の方法は、ストーリーボード イベント ハンドラーを設定し、ストーリーボードの状態がUI_ANIMATION_SCHEDULING_INSUFFICIENT_PRIORITYになったかどうかをチェックすることです。

状態がUI_ANIMATION_STORYBOARD_READYに達した後に Schedule を再度呼び出すことで、ストーリーボード を再利用できます。 ストーリーボードがUI_ANIMATION_STORYBOARD_BUILDINGまたはUI_ANIMATION_STORYBOARD_READY以外の状態で失敗し、schedulingResultUI_ANIMATION_SCHEDULING_ALREADY_SCHEDULEDに設定されている場合に、ストーリーボードをスケジュールしようとしました。

要件

   
サポートされている最小のクライアント Windows 8、Windows 7、および Windows 7 用プラットフォーム更新プログラム [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー サポートなし
対象プラットフォーム Windows
ヘッダー uianimation.h
[DLL] UIAnimation.dll

関連項目

IUIAnimationStoryboard2

IUIAnimationStoryboard2::Abandon

IUIAnimationStoryboard2::Conclude

IUIAnimationStoryboard2::Finish

IUIAnimationStoryboard2::GetStatus

IUIAnimationTimer::GetTime

UI_ANIMATION_SCHEDULING_RESULT

UI_ANIMATION_STORYBOARD_STATUS