Fonction RtmCreateEnumerationHandle

[Cette API a été remplacée par l’API Routage Table Manager version 2 et ne sera pas disponible au-delà de Windows Server 2003. Les applications doivent utiliser l’API Gestionnaire de table de routage version 2.]

La fonction RtmCreateEnumerationHandle retourne un handle à utiliser avec RtmEnumerateGetNextRoute pour analyser tous les itinéraires, ou un sous-ensemble d’itinéraires, connus du gestionnaire de tables de routage.

Syntaxe

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

Paramètres

ProtocolFamily [in]

Spécifie la famille de protocoles des itinéraires à énumérer.

ÉnumérationFlags [in]

Spécifie les itinéraires à énumérer. Ce paramètre limite l’ensemble des itinéraires retournés par l’API d’énumération à un sous-ensemble défini par les indicateurs suivants et les valeurs dans les membres correspondants de la structure pointées vers le paramètre CriteriaRoute . Ce paramètre peut prendre les valeurs suivantes.

ÉnumérationFlags	Signification
RTM_ONLY_THIS_NETWORK	Énumérez uniquement les itinéraires qui ont le même numéro de réseau que le membre RR_Network de la structure pointée par CriteriaRoute.
RTM_ONLY_THIS_INTERFACE	Énumérez uniquement les itinéraires qui ont été obtenus via l’interface spécifiée par le champ RR_InterfaceID de la structure pointée par CriteriaRoute.
RTM_ONLY_THIS_PROTOCOL	Énumérez uniquement les itinéraires qui ont été ajoutés par le protocole de routage spécifié par le champ RR_RoutingProtocol de la structure pointée par CriteriaRoute.
RTM_ONLY_BEST_ROUTES	Énumérez uniquement les meilleurs itinéraires vers chacun des réseaux de l’ensemble.

CriteriaRoute [in]

Pointeur vers une structure d’itinéraire spécifique à la famille de protocoles (RTM_IP_ROUTE ou RTM_IPX_ROUTE). Les valeurs membres de cette structure correspondent aux indicateurs spécifiés par le paramètre EnumerationFlags .

Valeur retournée

Si la fonction réussit, la valeur de retour est un HANDLE à utiliser avec les appels d’énumération suivants.

Si la fonction échoue ou si aucun itinéraire n’existe avec les critères spécifiés, la valeur de retour est NULL. Appelez GetLastError pour obtenir plus d’informations.

Valeur	Description
ERROR_NO_ROUTES	Aucun itinéraire n’a les critères spécifiés.
ERROR_INVALID_PARAMETER	Un ou plusieurs des paramètres d’entrée n’est pas valide (par exemple, famille de protocoles inconnu, indicateurs d’énumération non valides).
ERROR_NO_SYSTEM_RESOURCES	Les ressources sont insuffisantes pour effectuer l’opération.
ERROR_NOT_ENOUGH_MEMORY	La mémoire est insuffisante pour allouer le handle.

Spécifications

Condition requise	Valeur
Client minimal pris en charge	Aucun pris en charge
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Fin de la prise en charge des serveurs	Windows Server 2003
En-tête	Rtm.h
Bibliothèque	Rtm.lib
DLL	Rtm.dll

Voir aussi

Informations de référence sur le routage de la version 1 du Gestionnaire de table

Fonctions du Gestionnaire de table de routage version 1

Getlasterror

RTM_IP_ROUTE

RTM_IPX_ROUTE

RtmCloseEnumerationHandle

RtmEnumerateGetNextRoute