Fonction RtmGetEnumRoutes (rtmv2.h)
La fonction RtmGetEnumRoutes récupère l’ensemble suivant d’itinéraires dans l’énumération spécifiée.
Syntaxe
DWORD RtmGetEnumRoutes(
[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 jusqu’à l’énumération de route.
[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, RouteHandles est un pointeur vers une structure RTM_ROUTE_INFO .
Lors de la sortie, RouteHandles reçoit un tableau de handles vers les itinéraires.
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. |
|
Il n’y a plus d’itinéraires à énumérer. |
|
La mémoire est insuffisante pour effectuer cette opération. |
Remarques
Lorsque les itinéraires ne sont plus nécessaires, relâchez-les en appelant RtmReleaseRoutes.
Pour obtenir un exemple de code utilisant cette fonction, consultez Énumérer tous les itinéraires.
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 |