Funzione RtmGetFirstRoute

[Questa API è stata sostituita dall'API Gestione tabelle di routing versione 2 e non sarà disponibile oltre Windows Server 2003. Le applicazioni devono usare l'API Gestione tabelle di routing versione 2.]

La funzione RtmGetFirstRoute restituisce la prima route dal subset specificato di route nella tabella.

Sintassi

DWORD RtmGetFirstRoute(
  _In_    DWORD ProtocolFamily,
  _In_    DWORD EnumerationFlags,
  _Inout_ PVOID Route
);

Parametri

ProtocolFamily [in]

Specifica la famiglia di protocolli di route da recuperare, ad esempio IP o IPX.

EnumerationFlags [in]

Specifica i limiti del set di route eliminate a un subset definito da questi flag e i valori nei membri corrispondenti della struttura a cui punta il parametro CriteriaRoute . I flag sono uguali a quelli usati in RtmCreateEnumerationHandle.

Route [in, out]

In base all'input, Route punta a una struttura specifica della famiglia di protocolli ( RTM_IP_ROUTE o RTM_IPX_ROUTE).

La funzione chiamante fornisce i valori dei membri per questa struttura. Questi valori, insieme al parametro EnumerationFlags , specificano il set da cui restituire le route.

Output out, Route punta alla prima route che corrisponde ai criteri specificati.

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.

Valore	Descrizione
ERROR_INVALID_PARAMETER	Uno dei parametri non è valido.
ERROR_NO_ROUTES	Non sono presenti route che corrispondono ai criteri specificati.
ERROR_NO_SYSTEM_RESOURCES	Non sono disponibili risorse sufficienti per eseguire l'operazione.

Commenti

Le route vengono restituite nell'ordine seguente:

1. Numero di rete
2. Protocollo di routing
3. Identificatore di interfaccia
4. Indirizzo hop successivo

Questa funzione è meno efficiente della funzione di handle di enumerazione corrispondente, RtmEnumerateGetNextRoute.

Requisiti

Requisito	Valore
Client minimo supportato	Nessuno supportato
Server minimo supportato	Windows 2000 Server [solo app desktop]
Fine del supporto server	Windows Server 2003
Intestazione	Rtm.h
Libreria	Rtm.lib
DLL	Rtm.dll

Vedi anche

Informazioni di riferimento su Gestione tabelle di routing versione 1

Funzioni di Gestione tabelle di routing versione 1

RtmCloseEnumerationHandle

RtmCreateEnumerationHandle

RtmEnumerateGetNextRoute

RtmGetNextRoute