GetUnicastIpAddressEntry, funkcja

Funkcja GetUnicastIpAddressEntry pobiera informacje dotyczące istniejącego wpisu adresu IP emisji pojedynczej na komputerze lokalnym.

Składnia

NETIOAPI_API GetUnicastIpAddressEntry(
  _Inout_ PMIB_UNICASTIPADDRESS_ROW Row
);

Parametry

• row [in, out]
  Wskaźnik do wpisu struktury MIB_UNICASTIPADDRESS_ROW dla wpisu adresu IP emisji pojedynczej. Po pomyślnym powrocie ta struktura zostanie zaktualizowana o właściwości istniejącego adresu IP emisji pojedynczej.

Wartość zwracana

GetUnicastIpAddressEntry zwraca STATUS_SUCCESS, jeśli funkcja powiedzie się.

Jeśli funkcja nie powiedzie się, GetUnicastIpAddressEntry zwraca jeden z następujących kodów błędów:

Kod powrotny	Opis
STATUS_INVALID_PARAMETER	Do funkcji przekazano nieprawidłowy parametr. Ten błąd jest zwracany, jeśli wskaźnik o wartości null jest przekazywany w parametrze wiersza, element Address składowej struktury MIB_UNICASTIPADDRESS_ROW, że Row wskazuje parametr nie został ustawiony na prawidłowy adres IPv4 lub IPv6 emisji pojedynczej albo oba InterfaceLuid i InterfaceIndex składowych struktury MIB_UNICASTIPADDRESS_ROW nie zostały określone.
STATUS_NOT_FOUND	Nie można odnaleźć określonego interfejsu. Ten błąd jest zwracany, jeśli funkcja nie może odnaleźć interfejsu sieciowego określonego przez InterfaceLuid lub InterfaceIndex elementu członkowskiego struktury MIB_UNICASTIPADDRESS_ROW, do której wskazuje parametr wiersza.
STATUS_NOT_SUPPORTED	Żądanie nie jest obsługiwane. Ten błąd jest zwracany, jeśli na komputerze lokalnym nie znajduje się stos IPv4, a adres IPv4 został określony w adres elementu członkowskiego MIB_UNICASTIPADDRESS_ROW struktury, do którego wskazuje wiersz lub jeśli na komputerze lokalnym nie znajduje się stos IPv6 i adres IPv6 został określony w elemencie Adres.
inne	Użyj funkcji FormatMessage, aby uzyskać ciąg komunikatu dla zwróconego błędu.

Uwagi

Funkcja GetUnicastIpAddressEntry jest zwykle używana do pobierania istniejącego wpisu struktury MIB_UNICASTIPADDRESS_ROW do zmodyfikowania. Sterownik może następnie zmienić elementy członkowskie we wpisie MIB_UNICASTIPADDRESS_ROW, który chce zmodyfikować, a następnie wywołać funkcję SetUnicastIpAddressEntry.

W danych wejściowych sterownik musi zainicjować następujące elementy członkowskie struktury MIB_UNICASTIPADDRESS_ROW, do których wskazuje parametr wiersza.

• adres
  Ustaw prawidłowy adres IPv4 lub adres IPv6 i rodzinę emisji pojedynczej.

• InterfaceLuid lub InterfaceIndex
  Te elementy członkowskie są używane w kolejności wymienionej wcześniej. Dlatego jeśli określono InterfaceLuid, ten element członkowski jest używany do określania interfejsu. Jeśli nie ustawiono wartości elementu członkowskiego InterfaceLuid (wartość tego elementu członkowskiego została ustawiona na zero), element członkowski InterfaceIndex jest następnie używany do określania interfejsu.

Po pomyślnym wywołaniu GetUnicastIpAddressEntry pobiera inne właściwości adresu IP emisji pojedynczej i wypełnia strukturę MIB_UNICASTIPADDRESS_ROW wskazującą parametr Row.

Sterownik może wywołać funkcję GetUnicastIpAddressTable w celu wyliczenia wpisów adresu IP emisji pojedynczej na komputerze lokalnym.

Wymagania

Platforma docelowa	universal
Wersja	Dostępne w systemie Windows Vista i nowszych wersjach systemów operacyjnych Windows.
Nagłówek	Netioapi.h (include Netioapi.h)
Biblioteka	Netio.lib
IRQL	< DISPATCH_LEVEL

Zobacz też

CreateUnicastIpAddressEntry

DeleteUnicastIpAddressEntry

GetUnicastIpAddressTable

InitializeUnicastIpAddressEntry

MIB_UNICASTIPADDRESS_ROW

MIB_UNICASTIPADDRESS_TABLE

NotifyUnicastIpAddressChange

SetUnicastIpAddressEntry