Fonction RtmRegisterEntity (rtmv2.h)

Article
08/25/2023

La fonction RtmRegisterEntity inscrit un client avec un instance du gestionnaire de tables de routage pour une famille d’adresses spécifique. Le gestionnaire de table de routage retourne un handle d’inscription et un profil du instance. Le profil contient une liste de valeurs utilisées lors de l’appel d’autres fonctions. Les valeurs incluent le nombre maximal de destinations retournées dans une mémoire tampon par un seul appel.

L’inscription est la première action qu’un client doit effectuer.

Syntaxe

DWORD RtmRegisterEntity(
  [in]  PRTM_ENTITY_INFO           RtmEntityInfo,
  [in]  PRTM_ENTITY_EXPORT_METHODS ExportMethods,
  [in]  RTM_EVENT_CALLBACK         EventCallback,
  [in]  BOOL                       ReserveOpaquePointer,
  [out] PRTM_REGN_PROFILE          RtmRegProfile,
  [out] PRTM_ENTITY_HANDLE         RtmRegHandle
);

Paramètres

[in] RtmEntityInfo

Pointeur vers une structure RTM_ENTITY_INFO . Cette structure contient des informations qui identifient le client au gestionnaire de tables de routage, telles que le gestionnaire de tables de routage instance et la famille d’adresses avec laquelle s’inscrire.

[in] ExportMethods

Pointeur vers une structure RTM_ENTITY_EXPORT_METHODS qui contient une liste de méthodes exportées par le client. Ce paramètre est facultatif et peut être défini sur NULL si le client appelant n’a aucune méthode à exporter.

[in] EventCallback

Structure RTM_EVENT_CALLBACK qui spécifie le rappel que le gestionnaire de table de routage utilise pour notifier le client des événements. Les événements se produisent lorsqu’un client s’inscrit et annule l’inscription, lorsque les itinéraires expirent et quand des modifications apportées à la meilleure route vers une destination se sont produites. Seules les modifications spécifiées lorsque le client a appelé RtmRegisterForChangeNotification.

[in] ReserveOpaquePointer

Spécifie s’il faut réserver un pointeur opaque dans chaque destination pour cette instance du protocole. Spécifiez TRUE pour réserver un pointeur opaque dans chaque destination. Spécifiez FALSE pour ignorer cette action. Ces pointeurs opaques peuvent être utilisés pour pointer vers un contexte privé spécifique au protocole pour chaque destination.

[out] RtmRegProfile

En entrée, RtmRegProfile est un pointeur vers une structure RTM_REGN_PROFILE .

Lors de la sortie, RtmRegProfile est rempli avec la structure de profil d’inscription demandée. Le client doit utiliser les informations retournées dans d’autres appels de fonction (les informations retournées incluent le nombre de tronçons suivants à coût égal et le nombre maximal d’éléments retournés par un appel de fonction d’énumération).

[out] RtmRegHandle

Reçoit un handle d’inscription pour le client. Ce handle doit être utilisé dans tous les appels suivants au gestionnaire de table de routage.

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
ERROR_ALREADY_EXISTS	Le client spécifié s’est déjà inscrit auprès du gestionnaire de tables de routage.
ERROR_BAD_CONFIGURATION	Les informations de Registre du gestionnaire de tables de routage sont endommagées.
ERROR_FILE_NOT_FOUND	Les informations de Registre pour le gestionnaire de tables de routage sont introuvables.
ERROR_INVALID_DATA	Un paramètre contient des informations incorrectes.
ERROR_INVALID_PARAMETER	Un paramètre contient des informations incorrectes.
ERROR_NO_SYSTEM_RESOURCES	Il n’y a pas suffisamment de ressources système disponibles pour effectuer cette opération.
ERROR_NOT_ENOUGH_MEMORY	La mémoire est insuffisante pour effectuer cette opération.

Notes

Pour obtenir un exemple de code utilisant cette fonction, consultez S’inscrire auprès du gestionnaire de tables de routage.

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