IUIAnimationTimer::SetTimerUpdateHandler メソッド (uianimation.h)

タイマー更新ハンドラーを指定します。

構文

HRESULT SetTimerUpdateHandler(
  [in, optional] IUIAnimationTimerUpdateHandler *updateHandler,
  [in]           UI_ANIMATION_IDLE_BEHAVIOR     idleBehavior
);

パラメーター

[in, optional] updateHandler

タイマー更新ハンドラー、または NULL (「解説」を参照)。 指定したオブジェクトは 、IUIAnimationTimerUpdateHandler インターフェイスを 実装する必要があります。

[in] idleBehavior

アイドル状態のタイマーの動作を指定する UI_ANIMATION_IDLE_BEHAVIOR のメンバー。

戻り値

メソッドが成功した場合は、S_OK を返します。 更新ハンドラーが既にタイマーに接続されている場合、このメソッドは UI_E_TIMER_CLIENT_ALREADY_CONNECTEDを返します。 そうでない場合は、HRESULT エラー コードを返します。 エラー コードの一覧については、「 Windows アニメーション のエラー コード」を参照してください。

解説

タイマー更新ハンドラーは、タイマーから時間更新 (ティック) を受け取ります。 タイマーは、IUIAnimationTimerUpdateHandler::OnUpdate を呼び出すことによって更新を示します
指定したハンドラーの メソッド。

updateHandler パラメーターに NULL を渡すと、Windows アニメーションは、前に渡したハンドラー オブジェクトへの参照を解放します。 この手法は、 IUIAnimationManager::Shutdown メソッドを呼び出すことなく、参照サイクルを中断するために不可欠な場合があります。

例

例については、「 アニメーション マネージャーを更新する」を参照してください。

要件

関連項目

IUIAnimationTimer

IUIAnimationTimer::SetTimerEventHandler

IUIAnimationTimerUpdateHandler