Funzione GetIpForwardTable2 (netioapi.h)
La funzione GetIpForwardTable2 recupera le voci di route IP nel computer locale.
Sintassi
IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpForwardTable2(
[in] ADDRESS_FAMILY Family,
[out] PMIB_IPFORWARD_TABLE2 *Table
);
Parametri
[in] Family
Famiglia di indirizzi da recuperare.
I valori possibili per la famiglia di indirizzi sono elencati nel file di intestazione Winsock2.h . Si noti che i valori per la famiglia di indirizzi AF_ e le costanti della famiglia di protocolli PF_ sono identiche (ad esempio, AF_INET e PF_INET), in modo che sia possibile usare entrambe le costanti.
Nella Windows SDK rilasciata per Windows Vista e versioni successive, l'organizzazione dei file di intestazione è stata modificata e i valori possibili per questo membro sono definiti nel file di intestazione Ws2def.h. Si noti che il file di intestazione Ws2def.h viene automaticamente incluso in Winsock2.h e non deve mai essere usato direttamente.
I valori attualmente supportati sono AF_INET, AF_INET6 e AF_UNSPEC.
[out] Table
Puntatore a una struttura MIB_IPFORWARD_TABLE2 che contiene una tabella di voci di route IP nel computer locale.
Valore restituito
Se la funzione ha esito positivo, il valore restituito viene NO_ERROR.
Se la funzione ha esito negativo, il valore restituito è uno dei codici di errore seguenti.
| Codice restituito | Descrizione |
|---|---|
|
Alla funzione è stato passato un parametro non valido. Questo errore viene restituito se un puntatore NULL viene passato nel parametro Table o se il parametro Family non è stato specificato come AF_INET, AF_INET6 o AF_UNSPEC. |
|
Per completare l'operazione sono disponibili risorse di memoria insufficienti. |
|
Non sono state trovate voci di route IP specificate nel parametro Family . |
|
La richiesta non è supportata. Questo errore viene restituito se non si trova alcun stack IPv4 nel computer locale e AF_INET è stato specificato nel parametro Family . Questo errore viene restituito anche se non si trova alcun stack IPv6 nel computer locale e AF_INET6 è stato specificato nel parametro Family . Questo errore viene restituito anche nelle versioni di Windows in cui questa funzione non è supportata. |
|
Usare FormatMessage per ottenere la stringa del messaggio per l'errore restituito. |
Commenti
La funzione GetIpForwardTable2 viene definita in Windows Vista e versioni successive.
The
La funzione GetIpForwardTable2 enumera le voci di route IP in un sistema locale e restituisce queste informazioni in una struttura MIB_IPFORWARD_TABLE2 .
Le voci di route IP vengono restituite in una struttura MIB_IPFORWARD_TABLE2 nel buffer a cui punta il parametro Table . La struttura MIB_IPFORWARD_TABLE2 contiene un numero di voci di route IP e una matrice di strutture MIB_IPFORWARD_ROW2 per ogni voce di route IP. Quando queste strutture restituite non sono più necessarie, liberare la memoria chiamando FreeMibTable.
Il parametro Family deve essere inizializzato in AF_INET, AF_INET6 o AF_UNSPEC.
Si noti che la struttura MIB_IPFORWARD_TABLE2 restituita a cui punta il parametro Table può contenere spaziatura interna per l'allineamento tra il membro NumEntries e la prima voce della matrice MIB_IPFORWARD_ROW2 nel membro Table della struttura MIB_IPFORWARD_TABLE2 . La spaziatura interna per l'allineamento può essere presente anche tra le voci della matrice MIB_IPFORWARD_ROW2 . Qualsiasi accesso a una voce di matrice MIB_IPFORWARD_ROW2 deve presupporre che la spaziatura interna possa esistere.
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 (include Iphlpapi.h) |
| Libreria | Iphlpapi.lib |
| DLL | Iphlpapi.dll |