Funzione CreateIpForwardEntry2 (netioapi.h)

Articolo
02/29/2024

La funzione CreateIpForwardEntry2 crea una nuova voce di route IP nel computer locale.

Sintassi

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API CreateIpForwardEntry2(
  [in] const MIB_IPFORWARD_ROW2 *Row
);

Parametri

[in] Row

Puntatore a una voce di struttura MIB_IPFORWARD_ROW2 per una voce di route IP.

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
ERROR_ACCESS_DENIED	Accesso negato. Questo errore viene restituito in diverse condizioni che includono quanto segue: l'utente non dispone dei privilegi amministrativi necessari nel computer locale o l'applicazione non è in esecuzione in una shell avanzata come amministratore predefinito (amministratore RunAs).
ERROR_INVALID_PARAMETER	Alla funzione è stato passato un parametro non valido. Questo errore viene restituito se un puntatore NULL viene passato nel parametro Row , il membro DestinationPrefix del MIB_IPFORWARD_ROW2 a cui punta il parametro Row non è stato specificato, il membro NextHop del MIB_IPFORWARD_ROW2 a cui punta il parametro Row non è stato specificato oppure sia i membri InterfaceLuid o InterfaceIndex del MIB_IPFORWARD_ROW2 a cui punta la riga parametro non specificato. Questo errore viene restituito anche se il membro PreferredLifetime specificato nel MIB_IPFORWARD_ROW2 è maggiore del membro ValidLifetime o se SitePrefixLength nel MIB_IPFORWARD_ROW2 è maggiore della lunghezza del prefisso specificata in DestinationPrefix.
ERROR_NOT_FOUND	Impossibile trovare l'interfaccia specificata. Questo errore viene restituito se non è stato possibile trovare l'interfaccia di rete specificata dal membro InterfaceLuid o InterfaceIndex del MIB_IPNET_ROW2 a cui punta il parametro Row .
ERROR_NOT_SUPPORTED	La richiesta non è supportata. Questo errore viene restituito se l'interfaccia specificata non supporta le route. Questo errore viene restituito anche 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 a cui punta il 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 .
ERROR_OBJECT_ALREADY_EXISTS	L'oggetto esiste già. Questo errore viene restituito se il membro DestinationPrefix del MIB_IPFORWARD_ROW2 a cui punta il parametro Row è un duplicato di una voce di route IP esistente nell'interfaccia specificata dal membro InterfaceLuid o InterfaceIndex del MIB_IPFORWARD_ROW2.
Altri	Usare FormatMessage per ottenere la stringa del messaggio per l'errore restituito.

Commenti

La funzione CreateIpForwardEntry2 viene definita in Windows Vista e versioni successive.

La funzione CreateIpForwardEntry2 viene usata per aggiungere una nuova voce di indirizzo IP adiacente in un computer locale. La funzione InitializeIpForwardEntry deve essere utilizzata per inizializzare i membri di una voce di struttura MIB_IPFORWARD_ROW2 con valori predefiniti. Un'applicazione può quindi modificare i membri nella voce MIB_IPFORWARD_ROW2 che desidera modificare e quindi chiamare la funzione CreateIpForwardEntry2 .

Il membro DestinationPrefix nella struttura MIB_IPFORWARD_ROW2 a cui punta il parametro Row deve essere inizializzato in un prefisso di indirizzo IPv4 o IPv6 valido. Il membro NextHop nella struttura MIB_IPFORWARD_ROW2 a cui punta il parametro Row deve essere inizializzato in un indirizzo e una famiglia IPv4 o IPv6 validi. Inoltre, almeno uno dei membri seguenti nella struttura MIB_IPFORWARD_ROW2 punta al parametro Row deve essere inizializzato all'interfaccia: InterfaceLuid o InterfaceIndex.

I campi vengono usati nell'ordine indicato in precedenza. Quindi, se si specifica InterfaceLuid , questo membro viene usato per determinare l'interfaccia in cui aggiungere la voce di route IP. Se non è stato impostato alcun valore per il membro InterfaceLuid (i valori di questo membro sono stati impostati su zero), il membro InterfaceIndex viene usato successivamente per determinare l'interfaccia.

L'offset della metrica di route specificato nel membro Metric della struttura MIB_IPFORWARD_ROW2 a cui punta il parametro Row rappresenta solo parte della metrica di route completa. La metrica completa è una combinazione di questo offset della metrica di route aggiunto alla metrica di interfaccia specificata nel membro Metric della struttura MIB_IPINTERFACE_ROW dell'interfaccia associata. Un'applicazione può recuperare la metrica dell'interfaccia chiamando la funzione GetIpInterfaceEntry .

I membri Age e Origin della struttura MIB_IPFORWARD_ROW2 a cui punta row vengono ignorati quando viene chiamata la funzione CreateIpForwardEntry2 . Questi membri vengono impostati dallo stack di rete e non possono essere impostati usando la funzione CreateIpForwardEntry2 .

La funzione CreateIpForwardEntry2 avrà esito negativo se i membri DestinationPrefix e NextHop del MIB_IPFORWARD_ROW2 a cui punta il parametro Row sono duplicati di una voce di route IP esistente nell'interfaccia specificata nei membri InterfaceLuid o InterfaceIndex .

La funzione CreateIpForwardEntry2 può essere chiamata solo da un utente connesso come membro del gruppo Administrators. Se CreateIpForwardEntry2 viene chiamato da un utente che non è membro del gruppo Administrators, la chiamata di funzione avrà esito negativo e ERROR_ACCESS_DENIED viene restituito. Questa funzione può anche non riuscire a causa del controllo dell'account utente in Windows Vista e versioni successive. Se un'applicazione che contiene questa funzione viene eseguita da un utente connesso come membro del gruppo Administrators diverso dall'amministratore predefinito, questa chiamata avrà esito negativo a meno che l'applicazione non sia stata contrassegnata nel file manifesto con un set requestedExecutionLevel impostato su requireAdministrator. Se l'applicazione non dispone di questo file manifesto, un utente connesso come membro del gruppo Administrators diverso dall'amministratore predefinito deve quindi eseguire l'applicazione in una shell avanzata come amministratore predefinito (amministratore RunAs) affinché questa funzione abbia esito positivo.

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