NotifyRouteChange2-Funktion (netioapi.h)

Artikel
08/25/2023

Die NotifyRouteChange2-Funktion registriert sich für Änderungen an IP-Routeneinträgen auf einem lokalen Computer.

Syntax

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API NotifyRouteChange2(
  [in]      ADDRESS_FAMILY             AddressFamily,
  [in]      PIPFORWARD_CHANGE_CALLBACK Callback,
  [in]      PVOID                      CallerContext,
  [in]      BOOLEAN                    InitialNotification,
  [in, out] HANDLE                     *NotificationHandle
);

Parameter

[in] AddressFamily

Die Adressfamilie, für die Änderungsbenachrichtigungen registriert werden sollen.

Mögliche Werte für die Adressfamilie sind in der Headerdatei Winsock2.h aufgeführt. Beachten Sie, dass die Werte für die AF_ Adressfamilie und PF_ Protokollfamilienkonstanten identisch sind (z. B. AF_INET und PF_INET), sodass beide Konstanten verwendet werden können.

Im Windows SDK, das für Windows Vista und höher veröffentlicht wurde, wurden die organization von Headerdateien geändert, und mögliche Werte für dieses Element sind in der Headerdatei Ws2def.h definiert. Beachten Sie, dass die Ws2def.h-Headerdatei automatisch in Winsock2.h enthalten ist und nie direkt verwendet werden sollte.

Die derzeit unterstützten Werte sind AF_INET, AF_INET6 und AF_UNSPEC.

Wert	Bedeutung
AF_INET	Registrieren Sie sich nur für IPv4-Routenänderungsbenachrichtigungen.
AF_INET6	Registrieren Sie sich nur für IPv6-Routenänderungsbenachrichtigungen.
AF_UNSPEC	Registrieren Sie sich für IPv4- und IPv6-Routenänderungsbenachrichtigungen.

[in] Callback

Ein Zeiger auf die Funktion, die bei einer Änderung aufgerufen werden soll. Diese Funktion wird aufgerufen, wenn eine IP-Routenbenachrichtigung empfangen wird.

[in] CallerContext

Ein Benutzerkontext, der an die Rückruffunktion übergeben wird, die im Rückrufparameter angegeben ist, wenn eine IP-Routenbenachrichtigung empfangen wird.

[in] InitialNotification

Ein Wert, der angibt, ob der Rückruf unmittelbar nach Abschluss der Registrierung für änderungsbenachrichtigungen aufgerufen werden soll. Diese anfängliche Benachrichtigung weist nicht darauf hin, dass eine Änderung an einem IP-Routeneintrag aufgetreten ist. Der Zweck dieses Parameters, um die Bestätigung zu geben, dass der Rückruf registriert ist.

[in, out] NotificationHandle

Ein Zeiger, der verwendet wird, um ein Handle zurückzugeben, das später zum Aufheben der Registrierung der Änderungsbenachrichtigung verwendet werden kann. Bei erfolgreicher Ausführung wird in diesem Parameter ein Benachrichtigungshandle zurückgegeben. Wenn ein Fehler auftritt, wird NULL zurückgegeben.

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.

Rückgabecode	Beschreibung
ERROR_INVALID_HANDLE	Es ist ein interner Fehler aufgetreten, bei dem ein ungültiges Handle aufgetreten ist.
ERROR_INVALID_PARAMETER	Es wurde ein ungültiger Parameter an die Funktion übergeben. Dieser Fehler wird zurückgegeben, wenn der Family-Parameter weder AF_INET, AF_INET6 noch AF_UNSPEC wurde.
ERROR_NOT_ENOUGH_MEMORY	Es war nicht genügend Arbeitsspeicher vorhanden.
Andere	Verwenden Sie FormatMessage , um die Nachrichtenzeichenfolge für den zurückgegebenen Fehler abzurufen.

Hinweise

Die NotifyRouteChange2-Funktion ist unter Windows Vista und höher definiert.

Der Family-Parameter muss entweder auf AF_INET, AF_INET6 oder AF_UNSPEC festgelegt werden.

Der Aufruf der Rückruffunktion, die im Rückrufparameter angegeben ist, wird serialisiert. Die Rückruffunktion sollte als Funktion des Typs VOID definiert werden. Zu den Parametern, die an die Rückruffunktion übergeben werden, gehören Folgendes:

Parameter	BESCHREIBUNG
IN PVOID CallerContext	Der CallerContext-Parameter , der bei der Registrierung für Benachrichtigungen an die Funktion NotifyRouteChange2 übergeben wurde.
IN PMIB_IPFORWARD_ROW2 Zeile OPTIONAL	Ein Zeiger auf den MIB_IPFORWARD_ROW2 Eintrag für den geänderten IP-Routeneintrag. Dieser Parameter ist ein NULL-Zeiger , wenn der MIB_NOTIFICATION_TYPE Wert, der im NotificationType-Parameter an die Rückruffunktion übergeben wird, auf MibInitialNotification festgelegt ist. Dies kann nur auftreten, wenn der an NotifyRouteChange2 übergebeneInitialNotification-Parameter beim Registrieren für Benachrichtigungen auf TRUE festgelegt wurde.
IN MIB_NOTIFICATION_TYPE NotificationType	Der Benachrichtigungstyp. Dieses Element kann einer der Werte aus dem MIB_NOTIFICATION_TYPE Enumerationstyp sein, der in der Headerdatei Netioapi.h definiert ist.

Die im Rückrufparameter angegebene Rückruffunktion muss im gleichen Prozess implementiert werden wie die Anwendung, die die NotifyRouteChange2-Funktion aufruft . Wenn sich die Rückruffunktion in einer separaten DLL befindet, sollte die DLL geladen werden, bevor die NotifyRouteChange2-Funktion aufgerufen wird, um sich für Änderungsbenachrichtigungen zu registrieren.

Wenn die Rückruffunktion empfangen wird, wenn eine Änderung erfolgt und der Row-Parameter nicht NULL ist, enthält der Zeiger auf die im Row-Parameter übergebene MIB_IPFORWARD_ROW2 Struktur unvollständige Daten. Die in der MIB_IPFORWARD_ROW2-Struktur zurückgegebenen Informationen sind nur genügend Informationen, die eine Anwendung die GetIpForwardEntry2-Funktion aufrufen kann, um vollständige Informationen über die geänderte IP-Route abzufragen. Wenn die Rückruffunktion empfangen wird, sollte eine Anwendung eine MIB_IPFORWARD_ROW2 Struktur zuordnen und sie mit den Membern DestinationPrefix, NextHop, InterfaceLuid und InterfaceIndex in der MIB_IPFORWARD_ROW2 Struktur initialisieren, auf die vom empfangenen Row-Parameter verwiesen wird. Ein Zeiger auf diese neu initialisierte MIB_IPFORWARD_ROW2-Struktur sollte an die GetIpForwardEntry2-Funktion übergeben werden, um vollständige Informationen über die geänderte IP-Route abzurufen.

Der Speicher, auf den der Row-Parameter verweist, der in den Rückrufanzeigen verwendet wird, wird vom Betriebssystem verwaltet. Eine Anwendung, die eine Benachrichtigung empfängt, sollte niemals versuchen, den Speicher freizugeben, auf den der Row-Parameter verweist.

Nachdem die NotifyRouteChange2-Funktion aufgerufen wurde, um sich für Änderungsbenachrichtigungen zu registrieren, werden diese Benachrichtigungen weiterhin gesendet, bis die Anwendung die Registrierung für Änderungsbenachrichtigungen auflöst oder die Anwendung beendet wird. Wenn die Anwendung beendet wird, hebt das System die Registrierung für Änderungsbenachrichtigungen automatisch auf. Es wird weiterhin empfohlen, dass eine Anwendung die Registrierung für Änderungsbenachrichtigungen explizit aufhebt, bevor sie beendet wird.

Die Registrierung für Änderungsbenachrichtigungen wird nicht beibehalten, wenn das System heruntergefahren oder neu gestartet wird.

Um die Registrierung für Änderungsbenachrichtigungen aufzuheben, rufen Sie die Funktion CancelMibChangeNotify2 und übergeben den von NotifyRouteChange2 zurückgegebenenNotificationHandle-Parameter.

Eine Anwendung kann keine Funktion CancelMibChangeNotify2 aus dem Kontext des Threads aufrufen, der derzeit die Benachrichtigungsrückruffunktion für denselben NotificationHandle-Parameter ausführt. Andernfalls führt der Thread, der diesen Rückruf ausführt, zu einem Deadlock. Daher darf die CancelMibChangeNotify2-Funktion nicht direkt als Teil der Benachrichtigungsrückrufroutine aufgerufen werden. In einer allgemeineren Situation kann ein Thread, der die CancelMibChangeNotify2-Funktion ausführt, keine Ressource besitzen, für die der Thread, der einen Benachrichtigungsrückrufvorgang ausführt, warten würde, da dies zu einem ähnlichen Deadlock führen würde. Die CancelMibChangeNotify2-Funktion sollte von einem anderen Thread aufgerufen werden, von dem der Thread, der den Benachrichtigungsrückruf empfängt, keine Abhängigkeiten aufweist.

Anforderungen


Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	netioapi.h (include Iphlpapi.h)
Bibliothek	Iphlpapi.lib
DLL	Iphlpapi.dll