Delen via


De functie GetUnicastIpAddressEntry

De functie GetUnicastIpAddressEntry haalt informatie op voor een bestaande unicast-IP-adresvermelding op een lokale computer.

Syntaxis

NETIOAPI_API GetUnicastIpAddressEntry(
  _Inout_ PMIB_UNICASTIPADDRESS_ROW Row
);

Parameters

  • rij [in, uit]
    Een aanwijzer naar een MIB_UNICASTIPADDRESS_ROW structuurvermelding voor een unicast-IP-adresvermelding. Bij geslaagde terugkeer wordt deze structuur bijgewerkt met de eigenschappen voor een bestaand unicast-IP-adres.

Retourwaarde

GetUnicastIpAddressEntry- retourneert STATUS_SUCCESS als de functie slaagt.

Als de functie mislukt, retourneert GetUnicastIpAddressEntry 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 adres lid van de MIB_UNICASTIPADDRESS_ROW-structuur waarnaar de parameter rij verwijst, is niet ingesteld op een geldig unicast-IPv4- of IPv6-adres, of beide InterfaceLuid- en InterfaceIndex leden van de MIB_UNICASTIPADDRESS_ROW-structuur zijn niet opgegeven.

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 lid van de MIB_UNICASTIPADDRESS_ROW-structuur waarnaar de parameter Row verwijst, niet kan vinden.

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 het adres lid van de MIB_UNICASTIPADDRESS_ROW structuur waarnaar de rij parameter verwijst, of als er geen IPv6-stack op de lokale computer staat en er een IPv6-adres is opgegeven in het adres lid.

Overige

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

Opmerkingen

De functie GetUnicastIpAddressEntry wordt meestal gebruikt om een bestaande MIB_UNICASTIPADDRESS_ROW structuurvermelding op te halen die moet worden gewijzigd. Een stuurprogramma kan vervolgens de leden in de MIB_UNICASTIPADDRESS_ROW vermelding wijzigen die het wil wijzigen en vervolgens de SetUnicastIpAddressEntry functie aanroepen.

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

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

  • 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 GetUnicastIpAddressEntry de andere eigenschappen voor het unicast-IP-adres op en vult de MIB_UNICASTIPADDRESS_ROW structuur in waarnaar de parameter Rij parameter verwijst.

Uw stuurprogramma kan de GetUnicastIpAddressTable- functie aanroepen om de vermeldingen van het unicast-IP-adres 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

CreateUnicastIpAddressEntry-

DeleteUnicastIpAddressEntry-

GetUnicastIpAddressTable-

InitializeUnicastIpAddressEntry-

MIB_UNICASTIPADDRESS_ROW

MIB_UNICASTIPADDRESS_TABLE

NotifyUnicastIpAddressChange-

SetUnicastIpAddressEntry-