NotifyRouteChange2-Funktion
Die NotifyRouteChange2-Funktion registriert den Treiber, der bei Änderungen an IP-Routeneinträgen auf einem lokalen Computer benachrichtigt wird.
Syntax
NETIOAPI_API NotifyRouteChange2(
_In_ ADDRESS_FAMILY Family,
_In_ PIPFORWARD_CHANGE_CALLBACK Callback,
_In_ PVOID CallerContext,
_In_ BOOLEAN InitialNotification,
_Inout_ HANDLE *NotificationHandle
);
Parameter
Familie [in]
Die Adressfamilie, für die der Treiber für Änderungsbenachrichtigungen registriert werden soll.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 Sie beide Konstanten verwenden können.
Unter Windows Vista und höheren Versionen der Windows-Betriebssysteme werden mögliche Werte für den Family-Parameter in der Ws2def.h-Headerdatei definiert. Beachten Sie, dass die Ws2def.h-Headerdatei automatisch in Netioapi.h enthalten ist und Sie Ws2def.h niemals direkt verwenden sollten.
Die folgenden Werte werden derzeit für die Adressfamilie unterstützt:
AF_INET
Die IPv4-Adressfamilie. Wenn dieser Wert angegeben wird, registriert diese Funktion den Treiber nur für IPv4-Routenänderungsbenachrichtigungen.AF_INET6
Die IPv6-Adressfamilie. Wenn dieser Wert angegeben wird, registriert diese Funktion den Treiber nur für IPv6-Routenänderungsbenachrichtigungen.AF_UNSPEC
Die Adressfamilie ist nicht angegeben. Wenn dieser Wert angegeben wird, registriert diese Funktion den Treiber sowohl für IPv4- als auch für IPv6-Routenänderungsbenachrichtigungen.
Rückruf [in]
Ein Zeiger auf die Funktion, die bei einer Änderung aufgerufen werden soll. Diese Funktion wird aufgerufen, wenn eine Schnittstellenbenachrichtigung empfangen wird.CallerContext [in]
Ein Benutzerkontext, der an die Rückruffunktion übergeben wird, die im Rückrufparameter angegeben wird, wenn eine Schnittstellenbenachrichtigung empfangen wird.InitialNotification [in]
Ein Wert, der angibt, ob der Rückruf unmittelbar nach Abschluss der Registrierung für änderungsbenachrichtigungen aufgerufen werden soll. Diese erste Benachrichtigung weist nicht darauf hin, dass eine Änderung an der IP-Route aufgetreten ist. Der Zweck dieses Parameters, um die Bestätigung zu geben, dass der Rückruf registriert ist.NotificationHandle [ein, aus]
Ein Zeiger auf eine zu initialisierende MIB_IPINTERFACE_ROW Struktur. Bei erfolgreicher Rückgabe werden die Member in dieser Struktur mit Standardinformationen für eine Schnittstelle auf dem lokalen Computer initialisiert.
Rückgabewert
NotifyRouteChange2 gibt STATUS_SUCCESS zurück, wenn die Funktion erfolgreich ist.
Wenn die Funktion fehlschlägt, gibt NotifyRouteChange2 einen der folgenden Fehlercodes zurück.
| Rückgabecode | Beschreibung |
|---|---|
| ERROR_INVALID_HANDLE | Es ist ein interner Fehler aufgetreten, bei dem ein ungültiges Handle aufgetreten ist. |
| STATUS_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. |
| STATUS_NOT_ENOUGH_MEMORY | Es war nicht genügend Arbeitsspeicher vorhanden. |
| Andere | Verwenden Sie die FormatMessage-Funktion , um die Nachrichtenzeichenfolge für den zurückgegebenen Fehler abzurufen. |
Bemerkungen
Ihr Treiber muss den Family-Parameter auf AF_INET, AF_INET6 oder AF_UNSPEC festlegen.
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 an die NotifyRouteChange2-Funktion übergeben wird, wenn der Treiber für Änderungsbenachrichtigungen registriert wird. |
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. Diese Situation kann nur auftreten, wenn der InitialNotification-Parameter , der an NotifyRouteChange2 übergeben wird, beim Registrieren des Treibers für Änderungsbenachrichtigungen auf TRUE festgelegt wurde. |
IN MIB_NOTIFICATION_TYPE NotificationType |
Der Benachrichtigungstyp. Dieser Member kann einer der Werte aus dem MIB_NOTIFICATION_TYPE Enumerationstyp sein. |
Um die Registrierung des Treibers für Änderungsbenachrichtigungen aufzuheben, rufen Sie die Funktion CancelMibChangeNotify2 auf, und übergeben Sie den NotificationHandle-Parameter , den NotifyRouteChange2 zurückgibt.
Anforderungen
Zielplattform |
Universell |
Version |
Verfügbar in Windows Vista und höheren Versionen der Windows-Betriebssysteme. |
Header |
Netioapi.h (einschließlich Netioapi.h) |
Bibliothek |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |