FlushIpPathTable, funkcja

Funkcja FlushIpPathTable opróżnia tabelę ścieżki IP na komputerze lokalnym.

Składnia

NETIOAPI_API FlushIpPathTable(
  _In_ ADDRESS_FAMILY Family
);

Parametry

• rodziny [in]
  Rodzina adresów do opróżnienia.

  Możliwe wartości rodziny adresów są wymienione w pliku nagłówka Winsock2.h. Należy pamiętać, że wartości rodziny adresów AF_ i rodziny protokołów PF_ są identyczne (na przykład AF_INET i PF_INET), aby można było użyć dowolnej stałej.

  W systemie Windows Vista i nowszych wersjach systemów operacyjnych Windows możliwe wartości parametru Family są zdefiniowane w pliku nagłówka Ws2def.h. Należy pamiętać, że plik nagłówka Ws2def.h jest automatycznie dołączany do pliku Netioapi.h i nigdy nie należy bezpośrednio używać pliku Ws2def.h.

  Dla rodziny adresów są obecnie obsługiwane następujące wartości:

  • AF_INET
    Rodzina adresów IPv4. Po określeniu tej wartości ta funkcja opróżnia tabelę ścieżek IP zawierającą tylko wpisy IPv4.

  • AF_INET6
    Rodzina adresów IPv6. Po określeniu tej wartości ta funkcja opróżnia tabelę ścieżki IP zawierającą tylko wpisy IPv6.

  • AF_UNSPEC
    Rodzina adresów nie jest określona. Po określeniu tej wartości ta funkcja opróżnia tabelę adresów IP sąsiada zawierającą wpisy IPv4 i IPv6.

Wartość zwracana

FlushIpPathTable zwraca STATUS_SUCCESS, jeśli funkcja zakończy się pomyślnie.

Jeśli funkcja nie powiedzie się, FlushIpPathTable 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 parametr rodziny nie został określony jako AF_INET, AF_INET6 lub AF_UNSPEC.
STATUS_NOT_SUPPORTED	Żądanie nie jest obsługiwane. Ten błąd jest zwracany, jeśli żaden stos IPv4 nie znajduje się na komputerze lokalnym i AF_INET został określony w parametrze rodziny lub jeśli na komputerze lokalnym nie znajduje się stos IPv6 i AF_INET6 został określony w parametrze rodziny. Ten błąd jest również zwracany w wersjach systemu Windows, w których ta funkcja nie jest obsługiwana.
inne	Użyj funkcji FormatMessage, aby uzyskać ciąg komunikatu dla zwróconego błędu.

Uwagi

Funkcja FlushIpPathTable opróżnia lub usuwa wpisy ścieżki IP na komputerze lokalnym. Sterownik może użyć parametru rodziny, aby ograniczyć wpisy ścieżki IP do usunięcia do określonej rodziny adresów IP. Jeśli należy usunąć wpisy ścieżki IP dla protokołów IPv4 i IPv6, sterownik powinien ustawić parametr rodziny na AF_UNSPEC.

Sterownik musi zainicjować parametr rodziny do AF_INET, AF_INET6 lub AF_UNSPEC.

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ż

GetIpPathEntry

getIpPathTable

MIB_IPPATH_ROW

MIB_IPPATH_TABLE