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

IPinFlowControl

COM
IIDc56e9858-dbf3-4f6b-8119-384af2060deb継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

アクティブな出力ピンからのデータフローをブロックします。

メソッド 1

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

vtbl 3 HRESULT Block(DWORD dwBlockFlags, HANDLE hEvent)

Block メソッドは、ピンからのデータフローをブロックまたはブロック解除します。

dwBlockFlagsDWORDin

ピンをブロックするかブロック解除するかを示すフラグ。次のいずれかの値でなければなりません:

  • Zero: ピンからのデータフローをブロック解除します。
  • AM_PIN_FLOW_CONTROL_BLOCK: ピンからのデータフローをブロックします。
hEventHANDLEinイベントオブジェクトへのハンドル、または NULL。このパラメーターが非 NULL の場合、メソッドは非同期となり、直ちに戻ります。操作が完了すると、イベントがシグナル状態になります。このパラメーターが NULL の場合、メソッドは同期的に動作し、ピンがブロックされるまで完了しません。dwBlockFlags が 0 の場合、このパラメーターは NULL でなければなりません。

戻り値

HRESULT 値を返します。指定可能な値には次のものがあります。

戻り値 説明
S_FALSE
ピンは既にブロック解除されています。
S_OK
成功しました。
VFW_E_PIN_ALREADY_BLOCKED
ピンは既に別のスレッドでブロックされています。
VFW_E_PIN_ALREADY_BLOCKED_ON_THIS_THREAD
ピンは既に呼び出し側のスレッドでブロックされています。

解説(Remarks)

このメソッドは同期的にも非同期的にも呼び出すことができます:

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IPinFlowControl "{C56E9858-DBF3-4F6B-8119-384AF2060DEB}"
#usecom global IPinFlowControl IID_IPinFlowControl "{}"
#comfunc global IPinFlowControl_Block  3 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。