Delen via


De functie GetIpPathEntry

De functie GetIpPathEntry haalt informatie op voor een IP-padvermelding op een lokale computer.

Syntaxis

NETIOAPI_API GetIpPathEntry(
  _Inout_ PMIB_IPPATH_ROW Row
);

Parameters

  • rij [in, uit]
    Een aanwijzer naar een MIB_IPPATH_ROW structuurvermelding voor een IP-padvermelding. Bij geslaagde terugkeer wordt deze structuur bijgewerkt met de eigenschappen voor ip-padvermelding.

Retourwaarde

GetIpPathEntry- retourneert STATUS_SUCCESS als de functie slaagt.

Als de functie mislukt, retourneert GetIpPathEntry- een van de volgende foutcodes:

Retourcode Beschrijving
STATUS_INVALID_PARAMETER

Er is een ongeldige parameter doorgegeven aan de functie. Deze fout wordt geretourneerd als een NULL--aanwijzer wordt doorgegeven in de parameter rij, het si_family lid in het doellid lid van de MIB_IPPATH_ROW-structuur waarnaar de parameter voor rij niet is ingesteld op AF_INET of AF_INET6, of zowel InterfaceLuid als InterfaceIndex leden van de MIB_IPPATH_ROW structuur zijn niet opgegeven. Deze fout wordt ook geretourneerd als het si_family lid in de Bron lid van de MIB_IPPATH_ROW structuur niet overeenkomt met de doel-IP-adresfamilie en de si_family voor het bron-IP-adres niet is opgegeven als AF_UNSPEC.

STATUS_NOT_FOUND

Kan de opgegeven interface niet vinden. Deze fout wordt geretourneerd als de functie de netwerkinterface die is opgegeven door de InterfaceLuid- of InterfaceIndex niet kan vinden lid van de MIB_IPPATH_ROW-structuur waarnaar de parameter row verwijst.

STATUS_NOT_SUPPORTED

De aanvraag wordt niet ondersteund. Deze fout wordt geretourneerd als er geen IPv4-stack zich op de lokale computer bevindt en er een IPv4-adres is opgegeven in de bron- en doel- leden van de MIB_IPPATH_ROW-structuur waarnaar de rij- parameter verwijst, of als er geen IPv6-stack zich op de lokale computer bevindt en er een IPv6-adres is opgegeven in de bron- en doel leden.

Overige

Gebruik de functie FormatMessage om de berichttekenreeks voor de geretourneerde fout op te halen.

Opmerkingen

De functie GetIpPathEntry wordt gebruikt om een MIB_IPPATH_ROW structuurvermelding op te halen.

Bij invoer moet uw stuurprogramma de volgende leden van de MIB_IPPATH_ROW-structuur initialiseren waarnaar de rij- parameter verwijst.

  • doel-
    Ingesteld op een geldig IPv4- of IPv6-adres en -gezin.

  • bron
    Stel de adresfamilie in die is opgegeven in de bron- lid op de doel-IP-adresfamilie die is opgegeven in het Doel lid of op AF_UNSPEC.

  • InterfaceLuid of InterfaceIndex
    Deze leden worden gebruikt in de volgorde die eerder wordt vermeld. Dus als InterfaceLuid- is opgegeven, wordt dit lid gebruikt om de interface te bepalen. Als er geen waarde is ingesteld voor het InterfaceLuid lid (de waarde van dit lid is ingesteld op nul), wordt de InterfaceIndex lid naast het bepalen van de interface gebruikt.

Wanneer de aanroep is geslaagd, haalt GetIpPathEntry de andere eigenschappen voor de VERMELDING van het IP-pad op en vult de MIB_IPPATH_ROW structuur in waarnaar de parameter rij parameter verwijst.

Het stuurprogramma kan de functie GetIpPathTable aanroepen om de IP-padvermeldingen op een lokale computer op te sommen.

Eisen

Doelplatform

Universal

Versie

Beschikbaar in Windows Vista en latere versies van de Windows-besturingssystemen.

Rubriek

Netioapi.h (inclusief Netioapi.h)

Bibliotheek

Netio.lib

IRQL

< DISPATCH_LEVEL

Zie ook

FlushIpPathTable-

GetIpPathTable-

MIB_IPPATH_ROW

MIB_IPPATH_TABLE