Udostępnij przez


GetMulticastIpAddressEntry, funkcja

Funkcja GetMulticastIpAddressEntry pobiera informacje dotyczące istniejącego wpisu adresu IP multiemisji na komputerze lokalnym.

Składnia

NETIOAPI_API GetMulticastIpAddressEntry(
  _Inout_ PMIB_MULTICASTIPADDRESS_ROW Row
);

Parametry

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

Wartość zwracana

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

Jeśli funkcja nie powiedzie się, getMulticastIpAddressEntry 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 NULL jest przekazywany w parametrze wiersza, element Adres struktury MIB_MULTICASTIPADDRESS_ROW, do którego wskazuje parametr wiersza, nie został ustawiony na prawidłowy adres IPv4 lub IPv6 multiemisji albo oba InterfaceLuid i InterfaceIndex składowych struktury MIB_MULTICASTIPADDRESS_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_MULTICASTIPADDRESS_ROW wskazywanej przez 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 elemencie Adres struktury MIB_MULTICASTIPADDRESS_ROW, do którego wskazuje wiersz lub jeśli na komputerze lokalnym nie znajduje się stos IPv6, a 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 GetMulticastIpAddressEntry służy do pobierania istniejącego wpisu struktury MIB_MULTICASTIPADDRESS_ROW.

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

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

  • 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.

Gdy wywołanie zakończy się pomyślnie, GetMulticastIpAddressEntry pobiera inne właściwości adresu IP multiemisji i wypełnia strukturę MIB_MULTICASTIPADDRESS_ROW wskazującą wiersz.

Sterownik może wywołać funkcję GetMulticastIpAddressTable, aby wyliczyć wpisy adresów IP multiemisji 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ż

getMulticastIpAddressTable

MIB_MULTICASTIPADDRESS_ROW

MIB_MULTICASTIPADDRESS_TABLE