Funzione RtmCreateEnumerationHandle

[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 RtmCreateEnumerationHandle restituisce un handle da usare con RtmEnumerateGetNextRoute per analizzare tutte le route o un subset di route, noto per la gestione tabelle di routing.

Sintassi

HANDLE RtmCreateEnumerationHandle(
  _In_ DWORD ProtocolFamily,
  _In_ DWORD EnumerationFlags,
  _In_ PVOID CriteriaRoute
);

Parametri

ProtocolFamily [in]

Specifica la famiglia di protocolli delle route da enumerare.

EnumerationFlags [in]

Specifica le route da enumerare. Questo parametro limita il set di route restituite dall'API di enumerazione a un subset definito dai flag seguenti e dai valori nei membri corrispondenti della struttura a cui punta il parametro CriteriaRoute . Questo parametro può avere uno dei valori seguenti.

EnumerazioneFlags	Significato
RTM_ONLY_THIS_NETWORK	Enumerare solo le route con lo stesso numero di rete del membro RR_Network della struttura a cui punta CriteriaRoute.
RTM_ONLY_THIS_INTERFACE	Enumerare solo le route ottenute tramite l'interfaccia specificata dal campo RR_InterfaceID della struttura a cui punta CriteriaRoute.
RTM_ONLY_THIS_PROTOCOL	Enumerare solo le route aggiunte dal protocollo di routing specificato dal campo RR_RoutingProtocol della struttura a cui punta CriteriaRoute.
RTM_ONLY_BEST_ROUTES	Enumerare solo le route migliori per ognuna delle reti nel set.

CriteriaRoute [in]

Puntatore a una struttura di route specifica della famiglia di protocolli (RTM_IP_ROUTE o RTM_IPX_ROUTE). I valori dei membri in questa struttura corrispondono ai flag specificati dal parametro EnumerationFlags .

Valore restituito

Se la funzione ha esito positivo, il valore restituito è un handle da usare con le chiamate di enumerazione successive.

Se la funzione ha esito negativo o non esistono route con i criteri specificati, il valore restituito è NULL. Chiamare GetLastError per ottenere altre informazioni.

Valore	Descrizione
ERROR_NO_ROUTES	Non sono presenti route con i criteri specificati.
ERROR_INVALID_PARAMETER	Uno o più parametri di input non sono validi, ad esempio famiglia di protocolli sconosciuti, flag di enumerazione non validi.
ERROR_NO_SYSTEM_RESOURCES	Non sono disponibili risorse sufficienti per eseguire l'operazione.
ERROR_NOT_ENOUGH_MEMORY	Memoria insufficiente per allocare l'handle.

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

Getlasterror

RTM_IP_ROUTE

RTM_IPX_ROUTE

RtmCloseEnumerationHandle

RtmEnumerateGetNextRoute