Win32 API 日本語リファレンス
ホームUI.Animation › IUIAnimationStoryboardEventHandler

IUIAnimationStoryboardEventHandler

COM
IID3d5c9008-ec7c-4364-9f8a-9af3c58cbae6継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ストーリーボードのステータスイベントおよび更新イベントを処理するためのメソッドを定義します。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT OnStoryboardStatusChanged(IUIAnimationStoryboard* storyboard, UI_ANIMATION_STORYBOARD_STATUS newStatus, UI_ANIMATION_STORYBOARD_STATUS previousStatus)

ストーリーボードのステータスが変化したときに発生するイベントを処理します。

storyboardIUIAnimationStoryboard*inステータスが変化したストーリーボード。
newStatusUI_ANIMATION_STORYBOARD_STATUSin新しいステータス。
previousStatusUI_ANIMATION_STORYBOARD_STATUSin以前のステータス。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、Windows Animation Error Codes を参照してください。

解説(Remarks)

既定では、コールバックメソッド内から他のアニメーションメソッドを呼び出すと、呼び出しは失敗し UI_E_ILLEGAL_REENTRANCY を返します。ただし、この既定の動作には例外があります。次のメソッドは OnStoryboardStatusChanged から正常に呼び出すことができます。

vtbl 4 HRESULT OnStoryboardUpdated(IUIAnimationStoryboard* storyboard)

ストーリーボードが更新されたときに発生するイベントを処理します。

storyboardIUIAnimationStoryboard*in更新されたストーリーボード。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、Windows Animation Error Codes を参照してください。

解説(Remarks)

このメソッドは、ストーリーボードがアニメーション化しているアニメーション変数のうち少なくとも 1 つの値が、前回の IUIAnimationManager::Update メソッドの呼び出し以降に変化した場合に呼び出されます。

既定では、コールバックメソッド内から他のアニメーションメソッドを呼び出すと、呼び出しは失敗し UI_E_ILLEGAL_REENTRANCY を返します。ただし、この既定の動作には例外があります。次のメソッドは OnStoryboardUpdated から正常に呼び出すことができます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"

#define global IID_IUIAnimationStoryboardEventHandler "{3D5C9008-EC7C-4364-9F8A-9AF3C58CBAE6}"
#usecom global IUIAnimationStoryboardEventHandler IID_IUIAnimationStoryboardEventHandler "{}"
#comfunc global IUIAnimationStoryboardEventHandler_OnStoryboardStatusChanged  3 sptr,int,int
#comfunc global IUIAnimationStoryboardEventHandler_OnStoryboardUpdated        4 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。