MprAdminInterfaceGetHandle-Funktion (mprapi.h)

  • Artikel

Die Funktion MprAdminInterfaceGetHandle ruft ein Handle für eine angegebene Schnittstelle ab.

Syntax

DWORD MprAdminInterfaceGetHandle(
  [in]  MPR_SERVER_HANDLE hMprServer,
  [in]  LPWSTR            lpwsInterfaceName,
  [out] HANDLE            *phInterface,
  [in]  BOOL              fIncludeClientInterfaces
);

Parameter

[in] hMprServer

Handle an den Router, auf dem dieser Aufruf ausgeführt werden soll. Rufen Sie dieses Handle ab, indem Sie MprAdminServerConnect aufrufen.

[in] lpwsInterfaceName

Zeiger auf eine Unicode-Zeichenfolge mit NULL-Beendigung, die den Namen der abzurufenden Schnittstelle angibt.

[out] phInterface

Zeiger auf eine HANDLE-Variable , die ein Handle auf die durch lpwsInterfaceName angegebene Schnittstelle empfängt.

[in] fIncludeClientInterfaces

Gibt an, ob die Funktion eine Clientschnittstelle zurückgibt. Wenn dieser Parameter FALSE ist, werden Schnittstellen vom Typ ROUTER_IF_TYPE_CLIENT bei der Suche nach der Schnittstelle mit dem durch lpwsInterfaceName angegebenen Namen ignoriert. Wenn dieser Parameter TRUE ist und eine Schnittstelle mit dem angegebenen Namen vorhanden ist, gibt MprAdminInterfaceGetHandle ein Handle an eine Schnittstelle vom Typ ROUTER_IF_TYPE_CLIENT zurück. Da es möglicherweise mehrere Schnittstellen vom Typ ROUTER_IF_TYPE_CLIENT gibt, verweist das zurückgegebene Handle auf die erste Schnittstelle, die mit dem von lpwsInterfaceName angegebenen Namen gefunden wurde.

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_NO_SUCH_INTERFACE
 Es ist keine Schnittstelle mit dem von lpwsInterfaceName angegebenen Namen vorhanden.
RPC_S_INVALID_BINDING
 Das an den Server übergebene Handle ist NULL.
RPC_X_NULL_REF_POINTER
 lpwsInterfaceName ist NULL.
 
 

Anforderungen

   
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

MprAdminServerConnect

ROUTER_INTERFACE_TYPE

Routerverwaltungsfunktionen

Referenz zur Routerverwaltung