Funzione GetIpForwardEntry2 (netioapi.h)

Articolo
02/29/2024

La funzione GetIpForwardEntry2 recupera informazioni per una voce di route IP nel computer locale.

Sintassi

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpForwardEntry2(
  [in, out] PMIB_IPFORWARD_ROW2 Row
);

Parametri

[in, out] Row

Puntatore a una voce di struttura MIB_IPFORWARD_ROW2 per una voce di route IP. Al termine della restituzione, questa struttura verrà aggiornata con le proprietà per la voce di route IP.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è NO_ERROR.

Se la funzione ha esito negativo, il valore restituito è uno dei codici di errore seguenti.

Codice restituito	Descrizione
ERROR_INVALID_PARAMETER	Un parametro non valido è stato passato alla funzione. Questo errore viene restituito se un puntatore NULL viene passato nel parametro Row, il membro DestinationPrefix del MIB_IPFORWARD_ROW2 puntato dal parametro Row non è stato specificato, il membro NextHopdell'MIB_IPFORWARD_ROW2 puntato dal parametro Row non è stato specificato o sia i membri InterfaceLuid o InterfaceIndex del MIB_IPFORWARD_ROW2 puntati dalla riga parametro non specificato.
ERROR_NOT_FOUND	Element not found. Questo errore viene restituito se l'interfaccia di rete specificata dal membro InterfaceLuid o InterfaceIndex della struttura MIB_IPFORWARD_ROW2 puntata dal parametro Row non corrisponde al prefisso dell'indirizzo IP e alla famiglia di indirizzi specificata nel membro DestinationPrefix nella struttura MIB_IPFORWARD_ROW2 .
ERROR_NOT_SUPPORTED	La richiesta non è supportata. Questo errore viene restituito se non si trova alcun stack IPv4 nel computer locale e AF_INET è stato specificato nella famiglia di indirizzi nel membro DestinationPrefix del MIB_IPFORWARD_ROW2 puntato dal parametro Row . Questo errore viene restituito anche se non si trova alcun stack IPv6 nel computer locale e AF_INET6 è stato specificato per la famiglia di indirizzi nel membro DestinationPrefix .
Altri	Usare FormatMessage per ottenere la stringa di messaggio per l'errore restituito.

Commenti

La funzione GetIpForwardEntry2 è definita in Windows Vista e versioni successive.

La funzione GetIpForwardEntry2 viene usata per recuperare una voce di struttura MIB_IPFORWARD_ROW2 .

In input, il membro DestinationPrefix nella struttura MIB_IPFORWARD_ROW2 a cui punta il parametro Row deve essere inizializzato in un prefisso di indirizzi IPv4 o IPv6 valido. In input, il membro NextHop nella struttura MIB_IPFORWARD_ROW2 puntato dal parametro Row deve essere inizializzato in un indirizzo IPv4 o IPv6 valido e famiglia. Inoltre, almeno uno dei membri seguenti nella struttura MIB_IPFORWARD_ROW2 punta al parametro Row deve essere inizializzato: InterfaceLuid o InterfaceIndex.

I campi vengono usati nell'ordine elencato sopra. Quindi, se si specifica InterfaceLuid , questo membro viene usato per determinare l'interfaccia. Se non è stato impostato alcun valore per il membro InterfaceLuid (i valori di questo membro è stato impostato su zero), il membro InterfaceIndex viene usato successivamente per determinare l'interfaccia.

Nell'output quando la chiamata ha esito positivo, GetIpForwardEntry2 recupera le altre proprietà per la voce di route IP e compila la struttura MIB_IPFORWARD_ROW2 puntata dal parametro Row .

L'offset della metrica di route specificato nel membro Metrica della struttura MIB_IPFORWARD_ROW2 puntata dal parametro Row rappresenta solo parte della metrica di route completa. La metrica completa è una combinazione di questa metrica di route aggiunta alla metrica di interfaccia specificata nel membro Metrica della struttura MIB_IPINTERFACE_ROW dell'interfaccia associata. Un'applicazione può recuperare la metrica dell'interfaccia chiamando la funzione GetIpInterfaceEntry .

La funzione GetIpForwardTable2 può essere chiamata per enumerare le voci di route IP in un computer locale.

Requisiti

Requisito	Valore
Client minimo supportato	Windows Vista [solo app desktop]
Server minimo supportato	Windows Server 2008 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	netioapi.h (includere Iphlpapi.h)
Libreria	Iphlpapi.lib
DLL	Iphlpapi.dll