Sdílet prostřednictvím


GetUnicastIpAddressEntry – funkce

Funkce GetUnicastIpAddressEntry načte informace o existující položce IP adresy jednosměrového vysílání v místním počítači.

Syntax

NETIOAPI_API GetUnicastIpAddressEntry(
  _Inout_ PMIB_UNICASTIPADDRESS_ROW Row
);

Parametry

  • řádek [in, out]
    Ukazatel na položku struktury MIB_UNICASTIPADDRESS_ROW pro položku IP adresy jednosměrového vysílání. Při úspěšném vrácení se tato struktura aktualizuje o vlastnosti existující IP adresy jednosměrového vysílání.

Návratová hodnota

GetUnicastIpAddressEntry vrátí STATUS_SUCCESS, pokud bude funkce úspěšná.

Pokud funkce selže, GetUnicastIpAddressEntry vrátí jeden z následujících kódů chyb:

Návratový kód Popis
STATUS_INVALID_PARAMETER

Funkci byla předána neplatná hodnota parametru. Tato chyba se vrátí, pokud ukazatel null předá v parametru řádku řádku. Adresa člen struktury MIB_UNICASTIPADDRESS_ROW, na kterou odkazuje parametr řádek, nebyl nastaven na platnou adresu IPv4 nebo IPv6 jednosměrového vysílání, nebo InterfaceLuid i InterfaceIndex členy struktury MIB_UNICASTIPADDRESS_ROW nebyly zadány.

STATUS_NOT_FOUND

Zadané rozhraní nebylo nalezeno. Tato chyba se vrátí, pokud funkce nemůže najít síťové rozhraní určené InterfaceLuid nebo InterfaceIndex člen struktury MIB_UNICASTIPADDRESS_ROW, na kterou odkazuje řádek parametru.

STATUS_NOT_SUPPORTED

Požadavek není podporován. Tato chyba se vrátí, pokud v místním počítači není umístěn žádný zásobník IPv4 a adresa IPv4 byla zadána v Adresa člen struktury MIB_UNICASTIPADDRESS_ROW, na kterou odkazuje parametr řádek parametr, nebo pokud v místním počítači není umístěna žádná adresa IPv6 a adresa IPv6 byla zadána v adresa člen.

Jiné

Pomocí funkce FormatMessage získejte řetězec zprávy pro vrácenou chybu.

Poznámky

Funkce GetUnicastIpAddressEntry se obvykle používá k načtení existující položky struktury MIB_UNICASTIPADDRESS_ROW, která se má upravit. Ovladač pak může změnit členy v položce MIB_UNICASTIPADDRESS_ROW, kterou chce upravit, a potom volat funkci SetUnicastIpAddressEntry.

Při vstupu musí ovladač inicializovat následující členy MIB_UNICASTIPADDRESS_ROW struktury, na kterou odkazuje řádek parametru.

  • adresy
    Nastavte platnou jednosměrovou adresu IPv4 nebo IPv6 adresu a rodinu.

  • InterfaceLuid nebo InterfaceIndex
    Tito členové se používají v pořadí, které je uvedeno dříve. Pokud je tedy zadán InterfaceLuid, použije se tento člen k určení rozhraní. Pokud nebyla nastavena žádná hodnota pro InterfaceLuid člen (hodnota tohoto členu byla nastavena na nulu), InterfaceIndex člen se použije k určení rozhraní.

Při úspěšném volání GetUnicastIpAddressEntry načte další vlastnosti ip adresy jednosměrového vysílání a vyplní MIB_UNICASTIPADDRESS_ROW strukturu, na kterou odkazuje parametr řádek.

Ovladač může volat funkci GetUnicastIpAddressTable k vytvoření výčtu položek IP adres jednosměrového vysílání na místním počítači.

Požadavky

Cílová platforma

univerzální

Verze

K dispozici v systémech Windows Vista a novějších verzích operačních systémů Windows.

Záhlaví

Netioapi.h (včetně Netioapi.h)

Knihovna

Netio.lib

IRQL

< DISPATCH_LEVEL

Viz také

CreateUnicastIpAddressEntry

DeleteUnicastIpAddressEntry

GetUnicastIpAddressTable

InitializeUnicastIpAddressEntry

MIB_UNICASTIPADDRESS_ROW

MIB_UNICASTIPADDRESS_TABLE

NotifyUnicastIpAddressChange

SetUnicastIpAddressEntry