Fonction RtmGetRouteInfo (rtmv2.h)
La fonction RtmGetRouteInfo retourne des informations pour l’itinéraire spécifié.
Syntaxe
DWORD RtmGetRouteInfo(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_ROUTE_HANDLE RouteHandle,
[out] PRTM_ROUTE_INFO RouteInfo,
[out] PRTM_NET_ADDRESS DestAddress
);
Paramètres
[in] RtmRegHandle
Gérez le client obtenu à partir d’un appel précédent à RtmRegisterEntity.
[in] RouteHandle
Handle vers l’itinéraire à rechercher.
[out] RouteInfo
Si un pointeur doit être retourné : Lors de l’entrée, RouteInfo est un pointeur vers NULL. Lors de la sortie, RouteInfo reçoit un pointeur vers l’itinéraire ; sinon, RouteInfo reste inchangé.
Si un pointeur n’a pas besoin d’être retourné : En entrée, RouteInfo a la valeur NULL.
[out] DestAddress
Si un pointeur doit être retourné : Lors de l’entrée, DestAddress est un pointeur vers NULL. À la sortie, DestAddress reçoit un pointeur vers la structure RTM_NET_ADDRESS de la destination ; sinon, DestAddress reste inchangé.
Si un pointeur n’a pas besoin d’être retourné : à l’entrée, DestAddress a la valeur NULL.
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 |
|---|---|
|
Le handle n'est pas valide. |
Remarques
Lorsque les itinéraires ne sont plus nécessaires, libérez-les en appelant RtmReleaseRouteInfo.
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 |