MprAdminInterfaceUpdateRoutes-Funktion (mprapi.h)

Die Funktion MprAdminInterfaceUpdateRoutes fordert einen angegebenen Router-Manager auf, seine Routinginformationen für eine angegebene Schnittstelle zu aktualisieren.

Syntax

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

Parameter

[in] hMprServer

Verarbeiten Sie den Router, auf dem die Informationen aktualisiert werden. Rufen Sie dieses Handle ab, indem Sie MprAdminServerConnect aufrufen.

[in] hInterface

Behandeln Sie die zu aktualisierende Schnittstelle. Rufen Sie dieses Handle ab, indem Sie MprAdminInterfaceCreate aufrufen.

[in] dwProtocolId

Ein DWORD-Wert , der angibt, welcher Router-Manager seine Routinginformationen aktualisiert. Der Router verwendet für jedes Transportprotokoll einen anderen Router-Manager. Zulässige Werte für dwTransportId sind in der folgenden Tabelle aufgeführt.

Wert Transport (Protokollfamilie)
PID_ATALK Appletalk
PID_IP Internetprotokoll, Version 4
PID_IPX Internetpaketaustausch
PID_NBF NetBIOS Frames-Protokoll
PID_IPV6 Windows Server 2008 oder höher: Internetprotokoll, Version 6

[in] hEvent

Behandeln Sie ein Ereignis, das signalisiert wird, wenn der Versuch, Routinginformationen für die angegebene Schnittstelle zu aktualisieren, abgeschlossen ist. Bei NULL ist die Funktion synchron. Die aufrufende Anwendung muss NULL für diesen Parameter angeben, wenn hMprServer einen Remoterouter angibt.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert NO_ERROR.

Wenn die Funktion fehlschlägt, ist der Rückgabewert einer der folgenden Fehlercodes.

Wert Bedeutung
ERROR_ACCESS_DENIED
Die aufrufende Anwendung verfügt nicht über ausreichende Berechtigungen.
ERROR_INTERFACE_NOT_CONNECTED
Die angegebene Schnittstelle ist nicht verbunden. Daher können Routen nicht aktualisiert werden.
ERROR_INVALID_HANDLE
Der hInterface-Wert ist ungültig.
ERROR_NO_SUCH_INTERFACE
Der angegebene Transport wird nicht auf der angegebenen Schnittstelle ausgeführt.
ERROR_UNKNOWN_PROTOCOL_ID
Der dwTransportId-Wert stimmt mit keinem der Router-Manager überein.
ERROR_UPDATE_IN_PROGRESS
Für diese Schnittstelle wird bereits ein Routinginformationsaktualisierungsvorgang ausgeführt.
AUSSTEHENDE
Die Schnittstelle aktualisiert gerade Routinginformationen. Die aufrufende Anwendung muss auf das von hEvent angegebene Ereignisobjekt warten. Nachdem das Ereignis signalisiert wurde, kann die status des Aktualisierungsvorgangs abgerufen werden, indem Sie MprAdminInterfaceQueryUpdateResult aufrufen.

Hinweise

Der dwTransportId-Parameter gibt sowohl ein Transportprotokoll als auch einen eindeutigen Router-Manager an, da der Router für jeden Transport einen anderen Router-Manager verwendet.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Nicht unterstützt
Unterstützte Mindestversion (Server) Windows 2000 Server [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile mprapi.h
Bibliothek Mprapi.lib
DLL Mprapi.dll

Weitere Informationen

MprAdminInterfaceCreate

MprAdminInterfaceQueryUpdateResult

MprAdminServerConnect

Routerverwaltungsfunktionen

Referenz zur Routerverwaltung