Fonction RtmGetEnumDests (rtmv2.h)
La fonction RtmGetEnumDests récupère l’ensemble de destinations suivant dans l’énumération spécifiée.
Syntaxe
DWORD RtmGetEnumDests(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_ENUM_HANDLE EnumHandle,
[in, out] PUINT NumDests,
[out] PRTM_DEST_INFO DestInfos
);
Paramètres
[in] RtmRegHandle
Gérez le client obtenu à partir d’un appel précédent à RtmRegisterEntity.
[in] EnumHandle
Handle vers l’énumération de destination.
[in, out] NumDests
Lors de l’entrée, NumDests est un pointeur vers une valeur UINT spécifiant le nombre maximal de destinations pouvant être reçues par DestInfos. À la sortie, NumDests reçoit le nombre réel de destinations reçues par DestInfos.
[out] DestInfos
En entrée, DestInfos est un pointeur vers une structure RTM_DEST_INFO .
À la sortie, DestInfos reçoit un tableau de handles vers les destinations.
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 en un seul appel. Vérifiez RTM_REGN_PROFILE le nombre maximal de destinations que le client est autorisé à récupérer avec un appel. |
|
Il n’y a plus de destinations à énumérer. |
Notes
La structure pointée par DestInfos est une structure de taille variable. Si le client spécifie plusieurs vues avec TargetViews, la taille de DestInfos augmente pour chaque vue. Utilisez la macro RTM_SIZE_OF_DEST_INFO pour déterminer la taille d’une structure DestInfos à allouer avant d’appeler cette fonction. Utilisez la valeur spécifiée pour TargetViews comme paramètre pour RTM_SIZE_OF_DEST_INFO.
Lorsque les destinations ne sont plus nécessaires, libérez-les en appelant RtmReleaseDests.
Pour obtenir un exemple de code utilisant cette fonction, consultez Énumérer toutes les destinations.
Spécifications
| 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 |