RtmCreateEnumerationHandle fonction)

[cette api a été remplacée par l’api du gestionnaire de Table de routage Version 2 et ne sera pas disponible au-delà de Windows Server 2003. Les applications doivent utiliser l’API du 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 [ dans]

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

EnumerationFlags [ dans]

Spécifie les itinéraires qui doivent être énumérés. 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 des membres correspondants de la structure vers laquelle pointe le paramètre CriteriaRoute . Ce paramètre peut prendre les valeurs suivantes.

EnumerationFlags Signification
RTM _ uniquement _ ce _ réseau
Énumérer uniquement les itinéraires qui ont le même numéro de réseau que le _ membre de réseau RR de la structure vers laquelle pointe CriteriaRoute.
RTM _ uniquement _ cette _ interface
Énumère uniquement les itinéraires obtenus par le biais de l’interface spécifiée par le _ champ de RR InterfaceId de la structure vers laquelle pointe CriteriaRoute.
RTM _ uniquement _ ce _ protocole
Énumère uniquement les itinéraires qui ont été ajoutés par le protocole de routage spécifié par le _ champ ROUTINGPROTOCOL RR de la structure vers laquelle pointe CriteriaRoute.
les _ _ meilleurs _ itinéraires RTM
Énumérer uniquement les meilleurs itinéraires à chacun des réseaux de l’ensemble.

CriteriaRoute [ dans]

Pointeur vers une structure de route spécifique à la famille de protocoles (_ _ itinéraire IP RTM ou _ _ itinéraire IPX RTM). Les valeurs de membre de cette structure correspondent aux indicateurs spécifiés par le paramètre EnumerationFlags .

Valeur de retour

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

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

Valeur Description
ERREUR _ aucun _ itinéraire
Aucun itinéraire n’a les critères spécifiés.
paramètre d’erreur _ non valide _
Un ou plusieurs des paramètres d’entrée ne sont pas valides (par exemple, famille de protocole inconnue, indicateurs d’énumération non valides).
ERREUR _ aucune _ _ ressource système
Les ressources sont insuffisantes pour effectuer l’opération.
ERREUR _ de _ mémoire insuffisante _
La mémoire est insuffisante pour allouer le descripteur.

Configuration requise

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

Référence de la version 1 du gestionnaire de tables de routage

Fonctions de la version 1 du gestionnaire de table de routage

GetLastError

_itinéraire IP _ RTM

_itinéraire IPX _ RTM

RtmCloseEnumerationHandle

RtmEnumerateGetNextRoute