MprAdminTransportGetInfo-Funktion (mprapi.h)

  • Artikel

Die Funktion MprAdminTransportGetInfo ruft globale Informationen, Standardinformationen der Clientschnittstelle oder beides für einen angegebenen Transport ab.

Syntax

DWORD MprAdminTransportGetInfo(
  [in]            MPR_SERVER_HANDLE hMprServer,
  [in]            DWORD             dwTransportId,
  [out, optional] LPBYTE            *ppGlobalInfo,
  [out, optional] LPDWORD           lpdwGlobalInfoSize,
  [out, optional] LPBYTE            *ppClientInterfaceInfo,
  [out, optional] LPDWORD           lpdwClientInterfaceInfoSize
);

Parameter

[in] hMprServer

Handle an den Router, von dem Informationen abgerufen werden. Dieses Handle wird aus einem vorherigen Aufruf von MprAdminServerConnect abgerufen.

[in] dwTransportId

Ein DWORD-Wert , der den abzurufenden Transporttyp beschreibt. 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 Internet-Paketaustausch
PID_NBF NetBIOS Frames-Protokoll
PID_IPV6 Windows Server 2008 oder höher: Internetprotokoll, Version 6

[out, optional] ppGlobalInfo

Zeiger auf eine Zeigervariable. Diese Variable verweist auf einen Informationsheader, der globale Informationen für diesen Transport empfängt. Verwenden Sie die Informationsheaderfunktionen , um Informationsheader zu bearbeiten.

Geben Sie diesen Arbeitsspeicher frei, indem Sie MprAdminBufferFree aufrufen.

Dieser Parameter ist optional. Wenn die aufrufende Anwendung NULL für diesen Parameter angibt, ruft die Funktion die globalen Informationen nicht ab.

[out, optional] lpdwGlobalInfoSize

Zeiger auf eine DWORD-Variable . Diese Variable empfängt die Größe der globalen Informationen für den Transport in Bytes.

[out, optional] ppClientInterfaceInfo

Zeiger auf eine Zeigervariable. Diese Variable verweist auf Standardmäßige Clientschnittstelleninformationen für diesen Transport. Geben Sie diesen Arbeitsspeicher frei, indem Sie MprAdminBufferFree aufrufen.

Dieser Parameter ist optional. Wenn die aufrufende Anwendung NULL für diesen Parameter angibt, ruft die Funktion die Clientschnittstelleninformationen nicht ab.

[out, optional] lpdwClientInterfaceInfoSize

Zeiger auf eine DWORD-Variable . Diese Variable empfängt die Größe der Clientschnittstelleninformationen in Bytes.

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_INVALID_PARAMETER
 Es trifft eine der folgenden Bedingungen zu:
  • Der ppGlobalInfo-Parameter und der ppClientInterfaceInfo-Parameter sind beide NULL.
  • Der ppGlobalInfo-Parameter verweist nicht auf gültigen Arbeitsspeicher.
  • Der ppClientInterfaceInfo-Parameter verweist nicht auf gültigen Arbeitsspeicher.
ERROR_NOT_ENOUGH_MEMORY
 Unzureichende Ressourcen zum Abschließen des Vorgangs.
ERROR_UNKNOWN_PROTOCOL_ID
 Der DwTransportId-Wert stimmt mit keinem installierten Transport überein.

Hinweise

Die Parameter ppGlobalInfo und ppClientInterfaceInfo können nicht beide NULL sein.

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

MprAdminBufferFree

MprAdminServerConnect

MprAdminTransportSetInfo

Routerverwaltungsfunktionen

Referenz zur Routerverwaltung