GetMulticastIpAddressEntry 関数 (netioapi.h)
GetMulticastIpAddressEntry 関数は、ローカル コンピューター上の既存のマルチキャスト IP アドレス エントリの情報を取得します。
構文
IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetMulticastIpAddressEntry(
[in, out] PMIB_MULTICASTIPADDRESS_ROW Row
);
パラメーター
[in, out] Row
マルチキャスト IP アドレス エントリの MIB_MULTICASTIPADDRESS_ROW 構造体エントリへのポインター。 正常に戻ると、この構造体は既存のマルチキャスト IP アドレスのプロパティで更新されます。
戻り値
関数が成功した場合、戻り値はNO_ERROR。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
| リターン コード | 説明 |
|---|---|
|
指定されたファイルが見つかりません。 Row パラメーターが指すMIB_MULTICASTIPADDRESS_ROWの InterfaceLuid メンバーまたは InterfaceIndex メンバーによって指定されたネットワーク インターフェイス LUID またはインターフェイス インデックスがローカル コンピューター上の値でない場合、このエラーが返されます。 |
|
パラメーターが正しくありません。 このエラーは、Row パラメーターに NULL ポインターが渡された場合、Row パラメーターが指すMIB_MULTICASTIPADDRESS_ROWの Address メンバーが有効なマルチキャスト IPv4 アドレスまたは IPv6 アドレスに設定されていない場合、または Row パラメーターが指すMIB_MULTICASTIPADDRESS_ROWの InterfaceLuid メンバーまたは InterfaceIndex メンバーの両方が指定されていない場合に返されます。 |
|
Element not found. Row パラメーターが指すMIB_MULTICASTIPADDRESS_ROW構造体の InterfaceLuid または InterfaceIndex メンバーによって指定されたネットワーク インターフェイスが、MIB_MULTICASTIPADDRESS_ROW構造体の Address メンバーで指定された IP アドレスとアドレス ファミリと一致しない場合、このエラーが返されます。 |
|
要求はサポートされていません。 このエラーは、ローカル コンピューター上に IPv4 スタックがなく、Row パラメーターによって指MIB_MULTICASTIPADDRESS_ROWアドレス メンバーに IPv4 アドレスが指定されている場合に返されます。 このエラーは、ローカル コンピューターに IPv6 スタックがなく、 アドレス メンバーに IPv6 アドレスが指定されている場合にも返されます。 |
|
FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。 |
注釈
GetMulticastIpAddressEntry 関数は、Windows Vista 以降で定義されています。
GetMulticastIpAddressEntry 関数は、既存のMIB_MULTICASTIPADDRESS_ROW構造体エントリを取得するために使用されます。
入力時に、Row パラメーターが指すMIB_MULTICASTIPADDRESS_ROW構造体の Address メンバーは、有効なマルチキャスト IPv4 または IPv6 アドレスとファミリに初期化する必要があります。 さらに、Row パラメーターを指すMIB_MULTICASTIPADDRESS_ROW構造体の少なくとも 1 つのメンバーを初期化する必要があります。 InterfaceLuid または InterfaceIndex。
フィールドは、上記の順序で使用されます。 したがって、 InterfaceLuid が指定されている場合は、このメンバーを使用してインターフェイスが決定されます。 InterfaceLuid メンバーに値が設定されていない場合 (このメンバーの値が 0 に設定されている場合)、InterfaceIndex メンバーを使用してインターフェイスが決定されます。
呼び出しが成功した場合の出力時に、GetMulticastIpAddressEntry はマルチキャスト IP アドレスの他のプロパティを取得し、Row パラメーターが指すMIB_MULTICASTIPADDRESS_ROW構造体に入力します。
GetMulticastIpAddressTable 関数を呼び出して、ローカル コンピューター上のマルチキャスト IP アドレス エントリを列挙できます。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | netioapi.h (Iphlpapi.h を含む) |
| Library | Iphlpapi.lib |
| [DLL] | Iphlpapi.dll |