MgmGetProtocolOnInterface 関数 (mgm.h)

  • [アーティクル]

MgmGetProtocolOnInterface 関数は、指定されたインターフェイスを所有するマルチキャスト ルーティング プロトコルのプロトコル ID を取得します。

構文

DWORD MgmGetProtocolOnInterface(
  [in]      DWORD  dwIfIndex,
  [in]      DWORD  dwIfNextHopAddr,
  [in, out] PDWORD pdwIfProtocolId,
  [in, out] PDWORD pdwIfComponentId
);

パラメーター

[in] dwIfIndex

プロトコル ID を取得するインターフェイスのインデックスを指定します。

[in] dwIfNextHopAddr

dwIfIndex で指定されたインデックスに対応する次ホップのアドレスを指定します。 dwIfIndex パラメーターと dwIfNextHopIPAddr パラメーターは、ポイント対マルチポイント インターフェイスの次ホップを一意に識別します。 ポイント対マルチポイント インターフェイスは、1 つのインターフェイスが複数のネットワークに接続する接続です。 ポイント対マルチポイント インターフェイスの例としては、非ブロードキャスト マルチ アクセス (NBMA) インターフェイスと、すべてのダイヤルアップ クライアントが接続する内部インターフェイスがあります。

ブロードキャスト インターフェイス (イーサネット インターフェイスなど) またはポイントツーポイント インターフェイスの場合は、 dwIfIndex の値のみで識別されます。0 を指定します。

[in, out] pdwIfProtocolId

入力時に、クライアントは DWORD サイズのメモリ位置へのポインターを指定する必要があります。

出力時に、 pdwIfProtocolId は dwIfIndex で指定されたインターフェイス上のプロトコルの ID を受け取ります。

[in, out] pdwIfComponentId

入力時に、クライアントは DWORD 値へのポインターを指定する必要があります。

出力時に、 pdwIfComponentId はインターフェイス上のプロトコルのインスタンスのコンポーネント ID を受け取ります。 このパラメーターは pdwIfProtocolId と共に使用され、ルーティング プロトコルのインスタンスを一意に識別します。

戻り値

関数が成功した場合、戻り値はNO_ERROR。

関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。

値 意味
ERROR_CAN_NOT_COMPLETE
 この関数の呼び出しを完了できませんでした。
ERROR_NOT_FOUND
 指定されたインターフェイスがマルチキャスト グループ マネージャーによって見つかりませんでした。
 
 

要件

要件 値
サポートされている最小のクライアント サポートなし
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー mgm.h
Library Rtm.lib
[DLL] Rtm.dll

こちらもご覧ください

MgmReleaseInterfaceOwnership

MgmTakeInterfaceOwnership