IBDA_EthernetFilter
COM公式ドキュメント
IBDA_EthernetFilter インターフェイスは Network Provider に実装されます。
解説(Remarks)
このインターフェイスのインターフェイス識別子 (IID) を宣言するには、__uuidof 演算子を使用します: __uuidof(IBDA_EthernetFilter)。
メソッド 5
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
GetMulticastListSize メソッドは、現在リストにあるアドレスの数を取得します。
| pulcbAddresses | DWORD* | inout | Network Provider のリストに現在含まれているアドレスの数を受け取るポインターです。 |
戻り値
メソッドが成功した場合は S_OK を返します。失敗した場合はエラー コードを返します。
解説(Remarks)
アドレス リスト内のアドレスは、ネットワーク バイト順でバイト アラインされています。UlcbAddresses は常に Ethernet アドレスのサイズの整数倍になります。
PutMulticastList メソッドは、Network Provider にマルチキャスト アドレスのリストを設定します。
| ulcbAddresses | DWORD | in | リスト内のアドレスの数に、1 アドレスあたりのバイト数を掛けた値を指定します。 |
| pAddressList | BYTE* | in | バイト単位のサイズが ulcbAddresses と等しいアドレスの配列へのポインターです。 |
戻り値
メソッドが成功した場合は S_OK を返します。失敗した場合はエラー コードを返します。
GetMulticastList メソッドは、Network Provider のマルチキャスト アドレスのリストを取得します。
| pulcbAddresses | DWORD* | inout | 入力時には、取得するアドレスの最大数に 1 アドレスあたりのバイト数を掛けた値を指定します。出力時には、実際に取得されたバイト数を受け取ります。 |
| pAddressList | BYTE* | inout | バイト単位のサイズが ulcbAddresses と等しいアドレスの配列を受け取るポインターです。「解説」を参照してください。 |
戻り値
メソッドが成功した場合は S_OK を返します。失敗した場合はエラー コードを返します。
解説(Remarks)
pAddressList の宣言は COM に準拠していません。回避策として、クライアントが pAddressList バッファーを割り当てる必要があります。バッファーは pulcbAddresses パラメーターで通知したサイズと同じである必要があります。Network Provider は、呼び出し元が割り当てたバッファーに値を格納するだけです。
PutMulticastMode メソッドは、マルチキャスト モードを設定します。
| ulModeMask | DWORD | in | マルチキャスト モードを指定します。 |
戻り値
メソッドが成功した場合は S_OK を返します。失敗した場合はエラー コードを返します。
解説(Remarks)
指定可能な値については、Windows DDK を参照してください。
GetMulticastMode メソッドは、マルチキャスト モードを取得します。
| pulModeMask | DWORD* | out | マルチキャスト モードを受け取るポインターです。 |
戻り値
メソッドが成功した場合は S_OK を返します。失敗した場合はエラー コードを返します。
解説(Remarks)
指定可能な値については、Windows DDK を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IBDA_EthernetFilter "{71985F43-1CA1-11D3-9CC8-00C04F7971E0}" #usecom global IBDA_EthernetFilter IID_IBDA_EthernetFilter "{}" #comfunc global IBDA_EthernetFilter_GetMulticastListSize 3 var #comfunc global IBDA_EthernetFilter_PutMulticastList 4 int,var #comfunc global IBDA_EthernetFilter_GetMulticastList 5 var,var #comfunc global IBDA_EthernetFilter_PutMulticastMode 6 int #comfunc global IBDA_EthernetFilter_GetMulticastMode 7 var ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IBDA_EthernetFilter "{71985F43-1CA1-11D3-9CC8-00C04F7971E0}" #usecom global IBDA_EthernetFilter IID_IBDA_EthernetFilter "{}" #comfunc global IBDA_EthernetFilter_GetMulticastListSize 3 sptr #comfunc global IBDA_EthernetFilter_PutMulticastList 4 int,sptr #comfunc global IBDA_EthernetFilter_GetMulticastList 5 sptr,sptr #comfunc global IBDA_EthernetFilter_PutMulticastMode 6 int #comfunc global IBDA_EthernetFilter_GetMulticastMode 7 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。