GetUnicastIpAddressEntry függvény

A GetUnicastIpAddressEntry függvény lekéri a helyi számítógépen található meglévő egyedi küldésű IP-cím bejegyzés adatait.

Szintaxis

NETIOAPI_API GetUnicastIpAddressEntry(
  _Inout_ PMIB_UNICASTIPADDRESS_ROW Row
);

Paraméterek

  • sor [be, ki]
    Mutató egy MIB_UNICASTIPADDRESS_ROW struktúrabejegyzésre egy egyedi küldésű IP-címbejegyzéshez. Sikeres visszatérés esetén ez a struktúra frissül egy meglévő egyedi küldésű IP-cím tulajdonságaival.

Visszaadott érték

GetUnicastIpAddressEntry a függvény sikeres működése esetén STATUS_SUCCESS ad vissza.

Ha a függvény meghiúsul, GetUnicastIpAddressEntry a következő hibakódok egyikét adja vissza:

Kód visszaadása Leírás
STATUS_INVALID_PARAMETER

Érvénytelen paraméter lett átadva a függvénynek. Ez a hiba akkor jelenik meg, ha egy NULL mutatót ad át a Sor paraméterben, a CímMIB_UNICASTIPADDRESS_ROW struktúra azon tagját, amely szerint a sor paraméterpontok nem érvényes egycímes IPv4- vagy IPv6-címre voltak beállítva, vagy InterfaceLuid és InterfaceIndexMIB_UNICASTIPADDRESS_ROW-struktúra tagjai nem voltak meghatározva.

STATUS_NOT_FOUND

A megadott felület nem található. Ez a hiba akkor jelenik meg, ha a függvény nem találja a InterfaceLuid vagy InterfaceIndex által megadott hálózati adaptert, annak a MIB_UNICASTIPADDRESS_ROW struktúrának a tagját, amelyre a Sor paraméter mutat.

STATUS_NOT_SUPPORTED

A kérés nem támogatott. Ez a hiba akkor jelenik meg, ha nem található IPv4-verem a helyi számítógépen, és egy IPv4-cím van megadva a Cím azon MIB_UNICASTIPADDRESS_ROW struktúrában, amelyre a sor paraméter mutat, vagy ha nem található IPv6-verem a helyi számítógépen, és egy IPv6-cím van megadva a Cím tagban.

Egyéb

A FormatMessage függvénnyel szerezze be a visszaadott hiba üzenetsztringét.

Megjegyzések

A GetUnicastIpAddressEntry függvény általában egy módosítandó meglévő MIB_UNICASTIPADDRESS_ROW szerkezetbejegyzés lekérésére szolgál. Az illesztő ezután módosíthatja a módosítani kívánt MIB_UNICASTIPADDRESS_ROW bejegyzés tagjait, majd meghívhatja a SetUnicastIpAddressEntry függvényt.

Bemenetkor az illesztőprogramnak inicializálnia kell annak a MIB_UNICASTIPADDRESS_ROW struktúrának a következő tagjait, amelyekre a Sor paraméter mutat.

  • Cím
    Állítsa be érvényes egycímes IPv4- vagy IPv6-címre és -családra.

  • InterfaceLuid vagy InterfaceIndex
    Ezeket a tagokat a korábban felsorolt sorrendben használja a rendszer. Ha tehát InterfaceLuid van megadva, ez a tag határozza meg a felületet. Ha a InterfaceLuid taghoz nem állított be értéket (ennek a tagnak az értéke nulla volt), a InterfaceIndex tagot használja a rendszer a felület meghatározásához.

Ha a hívás sikeres, GetUnicastIpAddressEntry lekéri az egycímes IP-cím többi tulajdonságát, és kitölti azt a MIB_UNICASTIPADDRESS_ROW struktúrát, amelyre a Sor paraméter mutat.

Az illesztőprogram meghívhatja a GetUnicastIpAddressTable függvényt, hogy számba tudja adni az egycímes IP-cím bejegyzéseit egy helyi számítógépen.

Követelmények

Célplatform

Univerzális

Verzió

Elérhető a Windows Vista és a Windows operációs rendszerek újabb verzióiban.

Fejléc

Netioapi.h (netioapi.h)

Könyvtár

Netio.lib

IRQL

< DISPATCH_LEVEL

Lásd még:

CreateUnicastIpAddressEntry

DeleteUnicastIpAddressEntry

GetUnicastIpAddressTable

InitializeUnicastIpAddressEntry

MIB_UNICASTIPADDRESS_ROW

MIB_UNICASTIPADDRESS_TABLE

NotifyUnicastIpAddressChange

SetUnicastIpAddressEntry