Funzione GetIpForwardTable (iphlpapi.h)
La funzione GetIpForwardTable recupera la tabella di routing IPv4.
Sintassi
IPHLPAPI_DLL_LINKAGE DWORD GetIpForwardTable(
[out] PMIB_IPFORWARDTABLE pIpForwardTable,
[in, out] PULONG pdwSize,
[in] BOOL bOrder
);
Parametri
[out] pIpForwardTable
Puntatore a un buffer che riceve la tabella di routing IPv4 come struttura MIB_IPFORWARDTABLE .
[in, out] pdwSize
In input specifica le dimensioni in byte del buffer a cui punta il parametro pIpForwardTable .
In output, se il buffer non è abbastanza grande per contenere la tabella di routing restituita, la funzione imposta questo parametro uguale alla dimensione del buffer necessaria in byte.
[in] bOrder
Valore booleano che specifica se la tabella restituita deve essere ordinata. Se questo parametro è TRUE, la tabella viene ordinata nell'ordine di:
- Indirizzo di destinazione
- Protocollo che ha generato la route
- Criteri di routing multipath
- Indirizzo hop successivo
Valore restituito
Se la funzione ha esito positivo, il valore restituito è NO_ERROR (zero).
Se la funzione ha esito negativo, il valore restituito è uno dei codici di errore seguenti.
| Codice restituito | Descrizione |
|---|---|
|
Il buffer a cui punta il parametro pIpForwardTable non è sufficiente. Le dimensioni necessarie vengono restituite nella variabile DWORD a cui fa riferimento il parametro pdwSize . |
|
Il parametro pdwSize è NULL o GetIpForwardTable non è in grado di scrivere nella memoria a cui punta il parametro pdwSize . |
|
Non sono disponibili dati. Questo errore viene restituito se non sono presenti route nel computer locale. |
|
Questa funzione non è supportata nel sistema operativo in uso nel sistema locale. Questo errore viene restituito se non è installato alcun stack IP nel computer locale. |
|
Usare FormatMessage per ottenere la stringa di messaggio per l'errore restituito. |
Commenti
Il membro dwForwardProto della struttura MIB_IPFORWARDROW specifica il meccanismo di routing o protocollo che ha generato la route. Per un elenco di protocolli e meccanismi di routing possibili, vedere Identificatori di protocollo.
I membri dwForwardDest, dwForwardMask e dwForwardNextHop della struttura MIB_IPFORWARDROW rappresentano un indirizzo IPv4 nell'ordine di byte di rete.
Un indirizzo IPv4 pari a 0.0.0.0 nel membro dwForwardDest della struttura MIB_IPFORWARDROW viene considerata una route predefinita. La MIB_IPFORWARDTABLE può contenere più MIB_IPFORWARDROW voci con il membro dwForwardDest impostato su 0.0.0.0 quando sono installate più schede di rete.
Quando dwForwardAge è impostato su INFINITE, la route non verrà rimossa in base a un timeout
Valore. Qualsiasi altro valore per dwForwardAge specifica il numero di secondi dopo l'aggiunta o la modifica della route nella tabella di routing di rete.
In Windows Server 2003 o Windows 2000 Server quando il servizio routing e accesso remoto (RRAS) è in esecuzione, le MIB_IPFORWARDROW voci restituite hanno i membri dwForwardType e dwForwardAge impostati su zero.
In Windows Vista e Windows Server 2008 la metrica di route specificata nel membro dwForwardMetric1 della struttura MIB_IPFORWARDROW rappresenta una combinazione della metrica di route aggiunta alla metrica di interfaccia specificata nel membro Metricadella struttura MIB_IPINTERFACE_ROW dell'interfaccia associata. Pertanto, il membro dwForwardMetric1 della struttura MIB_IPFORWARDROW deve essere uguale o maggiore del membro Metricadella struttura MIB_IPINTERFACE_ROW associata. Se un'applicazione vuole impostare la metrica di route su 0 in Windows Vista e Windows Server 2008, il membro dwForwardMetric1della strutturaMIB_IPFORWARDROW deve essere impostato uguale al valore della metrica di interfaccia specificata nel membro Metrica della struttura MIB_IPINTERFACE_ROW associata. Un'applicazione può recuperare la metrica dell'interfaccia chiamando la funzione GetIpInterfaceEntry .
Un numero di membri delle voci della struttura MIB_IPFORWARDROW restituite da GetIpForwardTable non è attualmente usato dal routing IPv4. Questi membri includono dwForwardPolicy, dwForwardNextHopAS, dwForwardMetric2, dwForwardMetric3, dwForwardMetric4 e dwForwardMetric5.
Esempio
Nell'esempio seguente viene recuperata la tabella di routing IP, quindi vengono stampati alcuni campi per ogni route nella tabella.
// Need to link with Ws2_32.lib and Iphlpapi.lib
#include <winsock2.h>
#include <ws2tcpip.h>
#include <iphlpapi.h>
#include <stdio.h>
#pragma comment(lib, "iphlpapi.lib")
#pragma comment(lib, "ws2_32.lib")
#define MALLOC(x) HeapAlloc(GetProcessHeap(), 0, (x))
#define FREE(x) HeapFree(GetProcessHeap(), 0, (x))
/* Note: could also use malloc() and free() */
int main()
{
// Declare and initialize variables.
/* variables used for GetIfForwardTable */
PMIB_IPFORWARDTABLE pIpForwardTable;
DWORD dwSize = 0;
DWORD dwRetVal = 0;
char szDestIp[128];
char szMaskIp[128];
char szGatewayIp[128];
struct in_addr IpAddr;
int i;
pIpForwardTable =
(MIB_IPFORWARDTABLE *) MALLOC(sizeof (MIB_IPFORWARDTABLE));
if (pIpForwardTable == NULL) {
printf("Error allocating memory\n");
return 1;
}
if (GetIpForwardTable(pIpForwardTable, &dwSize, 0) ==
ERROR_INSUFFICIENT_BUFFER) {
FREE(pIpForwardTable);
pIpForwardTable = (MIB_IPFORWARDTABLE *) MALLOC(dwSize);
if (pIpForwardTable == NULL) {
printf("Error allocating memory\n");
return 1;
}
}
/* Note that the IPv4 addresses returned in
* GetIpForwardTable entries are in network byte order
*/
if ((dwRetVal = GetIpForwardTable(pIpForwardTable, &dwSize, 0)) == NO_ERROR) {
printf("\tNumber of entries: %d\n",
(int) pIpForwardTable->dwNumEntries);
for (i = 0; i < (int) pIpForwardTable->dwNumEntries; i++) {
/* Convert IPv4 addresses to strings */
IpAddr.S_un.S_addr =
(u_long) pIpForwardTable->table[i].dwForwardDest;
strcpy_s(szDestIp, sizeof (szDestIp), inet_ntoa(IpAddr));
IpAddr.S_un.S_addr =
(u_long) pIpForwardTable->table[i].dwForwardMask;
strcpy_s(szMaskIp, sizeof (szMaskIp), inet_ntoa(IpAddr));
IpAddr.S_un.S_addr =
(u_long) pIpForwardTable->table[i].dwForwardNextHop;
strcpy_s(szGatewayIp, sizeof (szGatewayIp), inet_ntoa(IpAddr));
printf("\n\tRoute[%d] Dest IP: %s\n", i, szDestIp);
printf("\tRoute[%d] Subnet Mask: %s\n", i, szMaskIp);
printf("\tRoute[%d] Next Hop: %s\n", i, szGatewayIp);
printf("\tRoute[%d] If Index: %ld\n", i,
pIpForwardTable->table[i].dwForwardIfIndex);
printf("\tRoute[%d] Type: %ld - ", i,
pIpForwardTable->table[i].dwForwardType);
switch (pIpForwardTable->table[i].dwForwardType) {
case MIB_IPROUTE_TYPE_OTHER:
printf("other\n");
break;
case MIB_IPROUTE_TYPE_INVALID:
printf("invalid route\n");
break;
case MIB_IPROUTE_TYPE_DIRECT:
printf("local route where next hop is final destination\n");
break;
case MIB_IPROUTE_TYPE_INDIRECT:
printf
("remote route where next hop is not final destination\n");
break;
default:
printf("UNKNOWN Type value\n");
break;
}
printf("\tRoute[%d] Proto: %ld - ", i,
pIpForwardTable->table[i].dwForwardProto);
switch (pIpForwardTable->table[i].dwForwardProto) {
case MIB_IPPROTO_OTHER:
printf("other\n");
break;
case MIB_IPPROTO_LOCAL:
printf("local interface\n");
break;
case MIB_IPPROTO_NETMGMT:
printf("static route set through network management \n");
break;
case MIB_IPPROTO_ICMP:
printf("result of ICMP redirect\n");
break;
case MIB_IPPROTO_EGP:
printf("Exterior Gateway Protocol (EGP)\n");
break;
case MIB_IPPROTO_GGP:
printf("Gateway-to-Gateway Protocol (GGP)\n");
break;
case MIB_IPPROTO_HELLO:
printf("Hello protocol\n");
break;
case MIB_IPPROTO_RIP:
printf("Routing Information Protocol (RIP)\n");
break;
case MIB_IPPROTO_IS_IS:
printf
("Intermediate System-to-Intermediate System (IS-IS) protocol\n");
break;
case MIB_IPPROTO_ES_IS:
printf("End System-to-Intermediate System (ES-IS) protocol\n");
break;
case MIB_IPPROTO_CISCO:
printf("Cisco Interior Gateway Routing Protocol (IGRP)\n");
break;
case MIB_IPPROTO_BBN:
printf("BBN Internet Gateway Protocol (IGP) using SPF\n");
break;
case MIB_IPPROTO_OSPF:
printf("Open Shortest Path First (OSPF) protocol\n");
break;
case MIB_IPPROTO_BGP:
printf("Border Gateway Protocol (BGP)\n");
break;
case MIB_IPPROTO_NT_AUTOSTATIC:
printf("special Windows auto static route\n");
break;
case MIB_IPPROTO_NT_STATIC:
printf("special Windows static route\n");
break;
case MIB_IPPROTO_NT_STATIC_NON_DOD:
printf
("special Windows static route not based on Internet standards\n");
break;
default:
printf("UNKNOWN Proto value\n");
break;
}
printf("\tRoute[%d] Age: %ld\n", i,
pIpForwardTable->table[i].dwForwardAge);
printf("\tRoute[%d] Metric1: %ld\n", i,
pIpForwardTable->table[i].dwForwardMetric1);
}
FREE(pIpForwardTable);
return 0;
} else {
printf("\tGetIpForwardTable failed.\n");
FREE(pIpForwardTable);
return 1;
}
}
Requisiti
| Client minimo supportato | Windows 2000 Professional [solo app desktop] |
| Server minimo supportato | Windows 2000 Server [solo app desktop] |
| Piattaforma di destinazione | Windows |
| Intestazione | iphlpapi.h |
| Libreria | Iphlpapi.lib |
| DLL | Iphlpapi.dll |
Vedi anche
Informazioni di riferimento sulla funzione helper IP