Funzione GetIpPathTable
La funzione GetIpPathEntry recupera informazioni per una voce di percorso IP in un computer locale.
Sintassi
NETIOAPI_API GetIpPathTable(
_In_ ADDRESS_FAMILY Family,
_Out_ PMIB_IPPATH_TABLE *Table
);
Parametri
famiglia [in]
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 di PF_ sono identiche (ad esempio, AF_INET e PF_INET), in modo da poter usare una delle costanti.
In Windows Vista e versioni successive dei sistemi operativi Windows, i valori possibili per il parametro Family sono definiti nel file di intestazione Ws2def.h. Si noti che il file di intestazione Ws2def.h viene incluso automaticamente in Netioapi.h e non usare mai Ws2def.h direttamente.
Per la famiglia di indirizzi sono attualmente supportati i valori seguenti:
AF_INET
Famiglia di indirizzi IPv4. Quando si specifica questo valore, questa funzione restituisce la tabella del percorso IP che contiene solo le voci IPv4.AF_INET6
Famiglia di indirizzi IPv6. Quando si specifica questo valore, questa funzione restituisce la tabella del percorso IP contenente solo le voci IPv6.AF_UNSPEC
La famiglia di indirizzi non è specificata. Quando questo valore viene specificato, questa funzione restituisce la tabella del percorso IP che contiene sia le voci IPv4 che IPv6.
tabella [out]
Puntatore a una struttura MIB_IPPATH_TABLE che contiene una tabella di voci di percorso IP nel computer locale.
Valore restituito
GetIpPathEntry restituisce STATUS_SUCCESS se la funzione ha esito positivo.
Se la funzione ha esito negativo, GetIpPathEntry 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 un puntatore NULL viene passato nel parametro Table o il parametro family non è stato specificato come AF_INET, AF_INET6 o AF_UNSPEC. |
| STATUS_NOT_ENOUGH_MEMORY | Per completare l'operazione sono disponibili risorse di memoria insufficienti. |
| STATUS_NOT_FOUND | Non sono state trovate voci di percorso IP, come specificato nel parametro Family. |
| 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 nel parametro famiglia di oppure se non si trova alcun stack IPv6 nel computer locale e AF_INET6 è stato specificato nel parametro famiglia di. Questo errore viene restituito anche nelle versioni di Windows in cui questa funzione non è supportata. |
| Altro | Usare la funzione FormatMessage per ottenere la stringa del messaggio per l'errore restituito. |
Osservazioni
La funzione GetIpPathTable enumera le voci del percorso IP in un computer locale e restituisce queste informazioni in una struttura MIB_IPPATH_TABLE.
GetIpPathTable restituisce le voci del percorso IP in una struttura MIB_IPPATH_TABLE nel buffer a cui punta il parametro Table. La struttura MIB_IPPATH_TABLE contiene un numero di voci di percorso IP e una matrice di strutture MIB_IPPATH_ROW per ogni voce di percorso IP. Quando queste strutture restituite non sono più necessarie, il driver deve liberare la memoria chiamando FreeMibTable.
Il driver deve inizializzare il parametro Family per AF_INET, AF_INET6 o AF_UNSPEC.
Si noti che la struttura MIB_IPPATH_TABLE restituita a cui punta il parametro Table potrebbe contenere spaziatura interna per l'allineamento tra il membro NumEntries e la prima voce della matrice MIB_IPPATH_ROW nel membro Table della struttura MIB_IPPATH_TABLE. La spaziatura interna per l'allineamento potrebbe essere presente anche tra le voci della matrice MIB_IPPATH_ROW. Qualsiasi accesso a una voce di matrice MIB_IPPATH_ROW deve presupporre che esista una spaziatura interna.
Fabbisogno
Piattaforma di destinazione |
universale |
Versione |
Disponibile in Windows Vista e versioni successive dei sistemi operativi Windows. |
Intestazione |
Netioapi.h (include Netioapi.h) |
Biblioteca |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |