GetMulticastIpAddressEntry-Funktion
Die GetMulticastIpAddressEntry-Funktion ruft Informationen für einen vorhandenen Multicast-IP-Adresseintrag auf einem lokalen Computer ab.
Syntax
NETIOAPI_API GetMulticastIpAddressEntry(
_Inout_ PMIB_MULTICASTIPADDRESS_ROW Row
);
Parameter
- Zeile [ein, aus]
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
GetMulticastIpAddressEntry gibt STATUS_SUCCESS zurück, wenn die Funktion erfolgreich ist.
Wenn die Funktion fehlschlägt, gibt GetMulticastIpAddressEntry einen der folgenden Fehlercodes zurück:
Rückgabecode | Beschreibung |
---|---|
STATUS_INVALID_PARAMETER | Es wurde ein ungültiger Parameter an die Funktion übergeben. Dieser Fehler wird zurückgegeben, wenn ein NULL-Zeiger im Row-Parameter übergeben wird, das Address-Element der MIB_MULTICASTIPADDRESS_ROW-Struktur , auf die der Row-Parameter verweist, nicht auf eine gültige Multicast-IPv4- oder IPv6-Adresse festgelegt wurde, oder sowohl InterfaceLuid - als auch InterfaceIndex-Member der MIB_MULTICASTIPADDRESS_ROW-Struktur nicht angegeben wurden. |
STATUS_NOT_FOUND | Die angegebene Schnittstelle konnte nicht gefunden werden. Dieser Fehler wird zurückgegeben, wenn die Funktion die Netzwerkschnittstelle nicht finden kann, die vom InterfaceLuid - oder InterfaceIndex-Member der MIB_MULTICASTIPADDRESS_ROW Struktur angegeben wird, auf die der Row-Parameter verweist. |
STATUS_NOT_SUPPORTED | Die Anforderung wird nicht unterstützt. Dieser Fehler wird zurückgegeben, wenn sich kein IPv4-Stapel auf dem lokalen Computer befindet und eine IPv4-Adresse im Adresselement der MIB_MULTICASTIPADDRESS_ROW-Struktur angegeben wurde, auf die der Row-Parameter verweist, oder wenn sich kein IPv6-Stapel auf dem lokalen Computer befindet und eine IPv6-Adresse im Adresselement angegeben wurde. |
Andere | Verwenden Sie die FormatMessage-Funktion , um die Nachrichtenzeichenfolge für den zurückgegebenen Fehler abzurufen. |
Bemerkungen
Die GetMulticastIpAddressEntry-Funktion wird verwendet, um einen vorhandenen MIB_MULTICASTIPADDRESS_ROW-Struktureintrag abzurufen.
Bei der Eingabe muss ihr Treiber die folgenden Member der MIB_MULTICASTIPADDRESS_ROW Struktur initialisieren, auf die der Row-Parameter verweist.
Adresse
Legen Sie auf eine gültige IPv4- oder IPv6-Adresse und -Familie fest.InterfaceLuid oder InterfaceIndex
Diese Member werden in der zuvor aufgeführten Reihenfolge verwendet. Wenn also InterfaceLuid angegeben ist, wird dieses Element verwendet, um die Schnittstelle zu bestimmen. Wenn kein Wert für das InterfaceLuid-Element festgelegt wurde (der Wert dieses Members wurde auf Null festgelegt), wird das InterfaceIndex-Element als nächstes verwendet, um die Schnittstelle zu bestimmen.
Wenn der Aufruf erfolgreich ist, ruft GetMulticastIpAddressEntry bei der Ausgabe 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.
Ihr Treiber kann die Funktion GetMulticastIpAddressTable aufrufen, um die Multicast-IP-Adresseinträge auf einem lokalen Computer aufzulisten.
Anforderungen
Zielplattform |
Universell |
Version |
Verfügbar in Windows Vista und höheren Versionen der Windows-Betriebssysteme. |
Header |
Netioapi.h (einschließlich Netioapi.h) |
Bibliothek |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |