Fonction RtmGetListEnumRoutes (rtmv2.h)
La fonction RtmGetListEnumRoutes énumère un ensemble d’itinéraires dans une liste de routes spécifiée.
Syntaxe
DWORD RtmGetListEnumRoutes(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_ENUM_HANDLE EnumHandle,
[in, out] PUINT NumRoutes,
[out] PRTM_ROUTE_HANDLE RouteHandles
);
Paramètres
[in] RtmRegHandle
Gérez le client obtenu à partir d’un appel précédent à RtmRegisterEntity.
[in] EnumHandle
Gérez la liste de routes à énumérer.
[in, out] NumRoutes
En entrée, NumRoutes est un pointeur vers une valeur UINT qui spécifie le nombre maximal d’itinéraires pouvant être reçus par RouteHandles.
À la sortie, NumRoutes reçoit le nombre réel d’itinéraires reçus par RouteHandles.
[out] RouteHandles
En entrée, DestInfo est un pointeur vers un tableau de structures RTM_DEST_INFO .
À la sortie, DestInfo est rempli avec les informations de destination demandées.
Valeur retournée
Si la fonction réussit, la valeur de retour est NO_ERROR.
Si la fonction échoue, la valeur de retour est l’un des codes d’erreur suivants.
| Valeur | Signification |
|---|---|
|
La valeur pointée par NumRoutes est supérieure au nombre maximal d’itinéraires qu’un client est autorisé à récupérer avec un seul appel. Vérifiez RTM_REGN_PROFILE le nombre maximal d’itinéraires que le client est autorisé à récupérer avec un seul appel. |
Remarques
Appelez cette fonction à plusieurs reprises pour récupérer tous les itinéraires.
Il n’y a plus d’itinéraires à énumérer lorsque le gestionnaire de table de routage retourne zéro dans NumRoutes.
Pour obtenir un exemple de code utilisant cette fonction, consultez Utiliser une liste de routes Client-Specific.
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] |
| Plateforme cible | Windows |
| En-tête | rtmv2.h |
| Bibliothèque | Rtm.lib |
| DLL | Rtm.dll |