Win32 API 日本語リファレンス
ホーム › Media.DirectShow › IESEvent

IESEvent

COM
📘 Microsoft Learn (日本語) · English
IID1f0e5357-af43-44e6-8547-654c645145d2継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

Protected Broadcast Driver Interface (PBDA) に対応するデバイスによって発生するイベントを配信およびカプセル化できる、汎用のイベントインターフェイスを実装します。

解説(Remarks)

このインターフェイスのインターフェイス識別子 (IID) を宣言するには、__uuidof 演算子を使用します: __uuidof(IESEvent)。

メソッド 5

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

vtbl 3 HRESULT GetEventId(DWORD* pdwEventId)

IESEvent インターフェイスから派生したイベントから、一意の識別子を取得します。イベント識別子は IESEvent オブジェクトに含まれており、このオブジェクトは IESEventService::FireESEvent の呼び出しで渡されます。

pdwEventIdDWORD*outイベント識別子を受け取ります。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 4 HRESULT GetEventType(GUID* pguidEventType)

IESEvent インターフェイスから派生したイベントを識別する GUID を取得します。この GUID は IESEvent オブジェクトに含まれており、このオブジェクトは IESEventService::FireESEvent の呼び出しで渡されます。

pguidEventTypeGUID*outイベントの種類を一意に識別する GUID へのポインター。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 5 HRESULT SetCompletionStatus(DWORD dwResult)

IESEvent インターフェイスから派生したイベントの完了ステータスを設定します。

dwResultDWORDinイベントの完了ステータス。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 6 HRESULT GetData(SAFEARRAY** pbData)

IESEvent インターフェイスから派生したイベントからデータを取得します。このメソッドは、IESEventService::FireESEvent の呼び出しで渡される IESEvent オブジェクト内のデータを格納したバイト配列を取得します。

pbDataSAFEARRAY**outイベントデータを受け取る SAFEARRAY へのポインター。 SAFEARRAY の解放は呼び出し側の責任です。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 7 HRESULT GetStringData(LPWSTR* pbstrData)

IESEvent インターフェイスから派生したイベントから、データを Unicode 文字列形式で取得します。データは IESEvent オブジェクトに含まれており、このオブジェクトは IESEventService::FireESEvent の呼び出しで渡されます。

pbstrDataLPWSTR*outIESEvent オブジェクトとともに渡されるデータを Unicode 文字列形式で受け取るバッファーへのポインター。このメモリは呼び出し側が解放する必要があります。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IESEvent "{1F0E5357-AF43-44E6-8547-654C645145D2}"
#usecom global IESEvent IID_IESEvent "{}"
#comfunc global IESEvent_GetEventId           3 var
#comfunc global IESEvent_GetEventType         4 var
#comfunc global IESEvent_SetCompletionStatus  5 int
#comfunc global IESEvent_GetData              6 var
#comfunc global IESEvent_GetStringData        7 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。