ホーム › Devices.Tapi › IMcastScope

IMcastScope

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IIDdf0daef4-a289-11d1-8697-006008b0e5d2継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

IMcastScope インターフェイスは、IMcastAddressAllocation::EnumerateScopes または IMcastAddressAllocation::get_Scopes を呼び出すことで取得します。

メソッド 5

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT get_ScopeID(INT* pID)

get_ScopeID メソッドは、マルチキャストアドレスのスコープの識別子を取得します。

pID

INT*

out

このスコープのスコープ ID を受け取る LONG へのポインター。これは、このスコープがマルチキャストサーバー上で構成されたときに、このスコープに割り当てられた ID です。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	呼び出し元が無効なポインター引数を渡しました。

vtbl 8 HRESULT get_ServerID(INT* pID)

get_ServerID メソッドは、このスコープに関連付けられたサーバー ID を取得します。

pID

INT*

out

このスコープのサーバー ID を受け取る LONG へのポインター。これは、このスコープを公開したマルチキャストアドレス割り当てサーバーに対して、そのサーバーが構成されたときに割り当てられた ID です。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	呼び出し元が無効なポインター引数を渡しました。

vtbl 9 HRESULT get_InterfaceID(INT* pID)

get_InterfaceID メソッドは、このスコープのインターフェイス識別子を取得します。これは、このスコープを公開したサーバーが存在するインターフェイスを識別します。通常は、そのインターフェイスのネットワークアドレスです。

pID

INT*

out

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	呼び出し元が無効なポインター引数を渡しました。

解説(Remarks)

InterfaceID は情報提供のみを目的として提供されており、これらのインターフェイスのいずれのメソッドでも入力としては必要とされません。ただし、アドレスを要求する際にどのスコープを使用するかというアプリケーション(またはユーザー)の判断材料になる場合があります。これは、マルチホーム環境では、あるネットワーク上で、別のネットワーク上のサーバーから取得したマルチキャストアドレスを使用すると、アドレスの競合が発生する可能性があるためです。

vtbl 10 HRESULT get_ScopeDescription(LPWSTR* ppDescription)

get_ScopeDescription メソッドは、このスコープに関連付けられたテキスト形式の説明を取得します。この説明はスコープの目的や意味を明確にするためだけに使用され、以降の呼び出しでは必要ありません。

ppDescription

LPWSTR*

out

このスコープの説明を受け取る BSTR へのポインター。この説明は、このスコープがマルチキャストサーバー上で構成されたときに設定されたものです。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	呼び出し元が無効なポインター引数を渡しました。
E_OUTOFMEMORY	文字列を割り当てるのに十分なメモリがありません。

解説(Remarks)

アプリケーションは、ppDescription パラメーターに割り当てられたメモリを解放するために SysFreeString を使用する必要があります。

vtbl 11 HRESULT get_TTL(INT* pTTL)

get_TTL メソッドは、マルチキャストスコープの time to live (TTL) 値を取得します。

pTTL

INT*

out

マルチキャストスコープの time to live 値へのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	呼び出し元が無効なポインター引数を渡しました。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IMcastScope "{DF0DAEF4-A289-11D1-8697-006008B0E5D2}"
#usecom global IMcastScope IID_IMcastScope "{}"
#comfunc global IMcastScope_get_ScopeID           7 var
#comfunc global IMcastScope_get_ServerID          8 var
#comfunc global IMcastScope_get_InterfaceID       9 var
#comfunc global IMcastScope_get_ScopeDescription  10 var
#comfunc global IMcastScope_get_TTL               11 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IMcastScope "{DF0DAEF4-A289-11D1-8697-006008B0E5D2}"
#usecom global IMcastScope IID_IMcastScope "{}"
#comfunc global IMcastScope_get_ScopeID           7 sptr
#comfunc global IMcastScope_get_ServerID          8 sptr
#comfunc global IMcastScope_get_InterfaceID       9 sptr
#comfunc global IMcastScope_get_ScopeDescription  10 sptr
#comfunc global IMcastScope_get_TTL               11 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。