Funzione GetIpForwardEntry2

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

Sintassi

NETIOAPI_API GetIpForwardEntry2(
  _Inout_ PMIB_IPFORWARD_ROW2 Row
);

Parametri

  • Riga [in, out]
    Puntatore a una voce di struttura MIB_IPFORWARD_ROW2 per una voce di route IP. In caso di esito positivo, questa struttura viene aggiornata con le proprietà per la voce di route IP.

Valore restituito

GetIpForwardEntry2 restituisce STATUS_SUCCESS se la funzione ha esito positivo.

Se la funzione ha esito negativo, GetIpForwardEntry2 restituisce uno dei codici di errore seguenti:

Codice restituito Descrizione
STATUS_INVALID_PARAMETER

Alla funzione è stato passato un parametro non valido. Questo errore viene restituito se si verifica una delle situazioni seguenti:

  • Un puntatore NULL viene passato nel parametro Row .

  • Membro DestinationPrefix della struttura MIB_IPFORWARD_ROW2 a cui il parametro Row punta non è stato specificato.

  • Il membro NextHop della struttura MIB_IPFORWARD_ROW2 non è stato specificato.

  • I membri InterfaceLuid e InterfaceIndex della struttura MIB_IPFORWARD_ROW2 non sono stati specificati.

  • Il membro PreferredLifetime della struttura MIB_IPFORWARD_ROW2 è maggiore del membro ValidLifetime .

  • Il membro SitePrefixLength della struttura MIB_IPFORWARD_ROW2 è maggiore della lunghezza del prefisso specificata dal membro DestinationPrefix .

STATUS_NOT_FOUND

Impossibile trovare l'interfaccia specificata. Questo errore viene restituito se la funzione non riesce a trovare l'interfaccia di rete specificata dal membro InterfaceLuid o InterfaceIndex della struttura MIB_IPFORWARD_ROW2 a cui punta il parametro Row .

STATUS_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 della struttura MIB_IPFORWARD_ROW2 a cui punta il parametro Row o se non si trova alcun stack IPv6 nel computer locale e AF_INET6 è stato specificato per la famiglia di indirizzi nel membro DestinationPrefix .

Altri

Utilizzare la funzione FormatMessage per ottenere la stringa di messaggio per l'errore restituito.

Commenti

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

All'input, il driver deve inizializzare i membri seguenti della struttura MIB_IPFORWARD_ROW2 a cui punta il parametro Row .

  • DestinationPrefix
    Impostare su un prefisso e una famiglia di indirizzi IPv4 o IPv6 validi.

  • NextHop
    Impostare su un indirizzo e una famiglia IPv4 o IPv6 validi.

  • InterfaceLuid o InterfaceIndex
    Questi membri vengono usati nell'ordine elencato in precedenza. Se quindi si specifica InterfaceLuid , questo membro viene usato per determinare l'interfaccia. Se non è stato impostato alcun valore per il membro InterfaceLuid (il valore di questo membro è stato impostato su zero), il membro InterfaceIndex viene usato successivamente per determinare l'interfaccia.

In caso di esito positivo della chiamata, GetIpForwardEntry2 recupera le altre proprietà per la voce di route IP e compila la struttura MIB_IPFORWARD_ROW2 a cui punta il parametro Row .

Offset della metrica di route specificato nel membro Metric della struttura MIB_IPFORWARD_ROW2 che il parametro Row punta a 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 driver può recuperare la metrica dell'interfaccia chiamando la funzione GetIpInterfaceEntry .

Il driver può chiamare la funzione GetIpForwardTable2 per enumerare le voci di route IP in un computer locale.

Requisiti

Piattaforma di destinazione

Universale

Versione

Disponibile in Windows Vista e versioni successive dei sistemi operativi Windows.

Intestazione

Netioapi.h (include Netioapi.h)

Libreria

Netio.lib

IRQL

< DISPATCH_LEVEL

Vedi anche

CreateIpForwardEntry2

DeleteIpForwardEntry2

GetBestRoute2

GetIpForwardTable2

GetIpInterfaceEntry

InitializeIpForwardEntry

MIB_IPFORWARD_ROW2

MIB_IPFORWARD_TABLE2

MIB_IPINTERFACE_ROW

NotifyRouteChange2

SetIpForwardEntry2