PGET_INTERFACE_INFO Rückruffunktion (routprot.h)

Artikel
08/25/2023

Die GetInterfaceInfo-Funktion ruft die Konfigurationsinformationen ab, die vom Routingprotokoll für eine bestimmte Schnittstelle gespeichert werden.

Syntax

PGET_INTERFACE_INFO PgetInterfaceInfo;

DWORD PgetInterfaceInfo(
  [in]      ULONG InterfaceIndex,
  [in]      PVOID InterfaceInfo,
  [in, out] PULONG BufferSize,
  [in]      PULONG StructureVersion,
  [in]      PULONG StructureSize,
  [in]      PULONG StructureCount
)
{...}

Parameter

[in] InterfaceIndex

Gibt die Schnittstelle in der Gruppe von Schnittstellen an, die auf dem Router konfiguriert sind.

[in] InterfaceInfo

Zeiger auf einen Puffer, der die protokolldefinierten Konfigurationsinformationen empfängt, die der Schnittstelle zugeordnet sind. Diese Informationen sind für das Routingprotokoll privat.

[in, out] BufferSize

Zeiger auf eine DWORD-Variable .

Bei Eingabe: Diese Variable gibt die Größe des Puffers in Bytes an, der zum Empfangen der Konfigurationsinformationen bereitgestellt wird.

Bei Ausgabe: Diese Variable empfängt die Größe der daten, die im Puffer platziert werden, in Byte. Wenn die Anfangsgröße nicht groß genug war, enthält diese Variable die Größe, die erforderlich ist, um alle Daten zu enthalten.

[in] StructureVersion

Gibt die Version der Informationsstrukturen an, auf die der Parameter InterfaceInfo verweist. In einigen Fällen entspricht dies der Version des Routingprotokolls.

[in] StructureSize

Gibt die Größe der einzelnen Informationsstrukturen an, auf die der Parameter InterfaceInfo verweist. Da einige Informationsstrukturen Elemente mit variabler Länge enthalten, ist das Routingprotokoll nicht unbedingt in der Lage, die Größe der Informationen aus der Version zu bestimmen.

[in] StructureCount

Gibt die Anzahl der Informationsstrukturen an, auf die der Parameter InterfaceInfo verweist. Dieser Parameter ist immer eins.

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	BESCHREIBUNG
ERROR_CAN_NOT_COMPLETE	Fehler beim Abrufen der Informationen.
ERROR_INVALID_PARAMETER	Der Parameter InterfaceIndex ist ungültig (z. B. ist keine Schnittstelle mit diesem Index vorhanden), oder der Parameter InterfaceInfoSize ist NULL.
ERROR_INSUFFICIENT_BUFFER	Die Größe des bereitgestellten Ausgabepuffers ist nicht groß genug, um die angeforderten Informationen zu enthalten. Die erforderliche Größe wird in der DWORD-Variablen zurückgegeben, auf die interfaceInfoSize verweist.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Nicht unterstützt
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	routprot.h

Weitere Informationen

Routingprotokollschnittstellenfunktionen

Referenz zur Routingprotokollschnittstelle

SetInterfaceInfo

Freigeben über