MprAdminInterfaceUpdateRoutes, fonction (mprapi.h)

Article
02/29/2024

La fonction MprAdminInterfaceUpdateRoutes demande à un gestionnaire de routeur spécifié de mettre à jour ses informations de routage pour une interface spécifiée.

Syntaxe

DWORD MprAdminInterfaceUpdateRoutes(
  [in] MPR_SERVER_HANDLE hMprServer,
  [in] HANDLE            hInterface,
  [in] DWORD             dwProtocolId,
  [in] HANDLE            hEvent
);

Paramètres

[in] hMprServer

Gérez le routeur sur lequel les informations sont mises à jour. Obtenez ce handle en appelant MprAdminServerConnect.

[in] hInterface

Handle vers l’interface en cours de mise à jour. Obtenez ce handle en appelant MprAdminInterfaceCreate.

[in] dwProtocolId

Valeur DWORD qui spécifie le gestionnaire de routeur qui met à jour ses informations de routage. Le routeur utilise un gestionnaire de routeur différent pour chaque protocole de transport. Les valeurs acceptables pour dwTransportId sont répertoriées dans le tableau suivant.

Valeur	Transport (famille de protocoles)
PID_ATALK	Appletalk
PID_IP	Protocole Internet version 4
PID_IPX	Internet Packet Exchange
PID_NBF	NetBIOS Frames Protocol
PID_IPV6	Windows Server 2008 ou version ultérieure : Protocole Internet version 6

[in] hEvent

Gérez un événement signalé lorsque la tentative de mise à jour des informations de routage pour l’interface spécifiée est terminée. Si la valeur est NULL, la fonction est synchrone. L’application appelante doit spécifier NULL pour ce paramètre, si hMprServer spécifie un routeur distant.

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_ACCESS_DENIED	L’application appelante ne dispose pas de privilèges suffisants.
ERROR_INTERFACE_NOT_CONNECTED	L’interface spécifiée n’est pas connectée. Par conséquent, les itinéraires ne peuvent pas être mis à jour.
ERROR_INVALID_HANDLE	La valeur hInterface n’est pas valide.
ERROR_NO_SUCH_INTERFACE	Le transport spécifié n’est pas en cours d’exécution sur l’interface spécifiée.
ERROR_UNKNOWN_PROTOCOL_ID	La valeur dwTransportId ne correspond à aucun des gestionnaires de routeur.
ERROR_UPDATE_IN_PROGRESS	Une opération de mise à jour des informations de routage est déjà en cours sur cette interface.
ATTENTE	L’interface est en cours de mise à jour des informations de routage. L’application appelante doit attendre sur l’objet d’événement spécifié par hEvent. Une fois l’événement signalé, le status de l’opération de mise à jour peut être obtenu en appelant MprAdminInterfaceQueryUpdateResult.

Remarques

Le paramètre dwTransportId spécifie à la fois un protocole de transport et un gestionnaire de routeur unique, car le routeur utilise un gestionnaire de routeur différent pour chaque transport.

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	mprapi.h
Bibliothèque	Mprapi.lib
DLL	Mprapi.dll