GetMulticastIpAddressEntry-Funktion (netioapi.h)
Die GetMulticastIpAddressEntry-Funktion ruft Informationen für einen vorhandenen Multicast-IP-Adresseintrag auf dem lokalen Computer ab.
Syntax
IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetMulticastIpAddressEntry(
[in, out] PMIB_MULTICASTIPADDRESS_ROW Row
);
Parameter
[in, out] Row
Ein Zeiger auf einen MIB_MULTICASTIPADDRESS_ROW Struktureintrag für einen Multicast-IP-Adresseintrag. Bei erfolgreicher Rückgabe wird diese Struktur mit den Eigenschaften für eine vorhandene Multicast-IP-Adresse aktualisiert.
Rückgabewert
Wenn die Funktion erfolgreich ist, wird der Rückgabewert NO_ERROR.
Wenn die Funktion fehlschlägt, ist der Rückgabewert einer der folgenden Fehlercodes.
| Rückgabecode | Beschreibung |
|---|---|
|
Die angegebene Datei wurde nicht gefunden. Dieser Fehler wird zurückgegeben, wenn die netzwerkschnittstellen-LUID oder der Schnittstellenindex, der vom InterfaceLuid- oder InterfaceIndex-Member des MIB_MULTICASTIPADDRESS_ROW angegeben wird, auf den der Row-Parameter verweist, kein Wert auf dem lokalen Computer ist. |
|
Ein Parameter ist falsch. Dieser Fehler wird zurückgegeben, wenn ein NULL-Zeiger im Row-Parameter übergeben wird, das Address-Element des MIB_MULTICASTIPADDRESS_ROW, auf das vom Row-Parameter verwiesen wird, nicht auf eine gültige Multicast-IPv4- oder IPv6-Adresse festgelegt ist, oder die InterfaceLuid- oder InterfaceIndex-Member des MIB_MULTICASTIPADDRESS_ROW, auf das vom Row-Parameter verwiesen wird, sind nicht angegeben. |
|
Element wurde nicht gefunden. Dieser Fehler wird zurückgegeben, wenn die Netzwerkschnittstelle, die vom InterfaceLuid - oder InterfaceIndex-Member der MIB_MULTICASTIPADDRESS_ROW Struktur angegeben wird, auf die der Row-Parameter verweist, nicht mit der IP-Adresse und Adressfamilie übereinstimmt, die im Adresselement in der MIB_MULTICASTIPADDRESS_ROW-Struktur angegeben sind. |
|
Die Anforderung wird nicht unterstützt. Dieser Fehler wird zurückgegeben, wenn sich auf dem lokalen Computer kein IPv4-Stapel befindet und eine IPv4-Adresse im Adresselement angegeben ist , auf das der Parameter Row verweist MIB_MULTICASTIPADDRESS_ROW. Dieser Fehler wird auch zurückgegeben, wenn sich auf dem lokalen Computer kein IPv6-Stapel befindet und im Adresselement eine IPv6-Adresse angegeben ist. |
|
Verwenden Sie FormatMessage , um die Nachrichtenzeichenfolge für den zurückgegebenen Fehler abzurufen. |
Hinweise
Die GetMulticastIpAddressEntry-Funktion ist unter Windows Vista und höher definiert.
Die GetMulticastIpAddressEntry-Funktion wird verwendet, um einen vorhandenen MIB_MULTICASTIPADDRESS_ROW-Struktureintrag abzurufen.
Bei der Eingabe muss das Adresselement in der MIB_MULTICASTIPADDRESS_ROW Struktur, auf die der Row-Parameter verweist, für eine gültige Multicast-IPv4- oder IPv6-Adresse und -Familie initialisiert werden. Darüber hinaus muss mindestens eines der folgenden Elemente in der MIB_MULTICASTIPADDRESS_ROW Struktur, die auf den Row-Parameter verweist, initialisiert werden: InterfaceLuid oder InterfaceIndex.
Die Felder werden in der oben aufgeführten Reihenfolge verwendet. Wenn also interfaceLuid angegeben wird, wird dieses Element verwendet, um die Schnittstelle zu bestimmen. Wenn kein Wert für das InterfaceLuid-Element festgelegt ist (der Wert dieses Members ist auf Null festgelegt), wird das InterfaceIndex-Element als nächstes verwendet, um die Schnittstelle zu bestimmen.
Bei der Ausgabe, wenn der Aufruf erfolgreich ist, ruft GetMulticastIpAddressEntry die anderen Eigenschaften für die Multicast-IP-Adresse ab und füllt die MIB_MULTICASTIPADDRESS_ROW Struktur aus, auf die der Row-Parameter verweist.
Die GetMulticastIpAddressTable-Funktion kann aufgerufen werden, um die Multicast-IP-Adresseinträge auf einem lokalen Computer aufzulisten.
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) | Windows Vista [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) | Windows Server 2008 [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | netioapi.h (include Iphlpapi.h) |
| Bibliothek | Iphlpapi.lib |
| DLL | Iphlpapi.dll |