Funzione MprAdminInterfaceGetHandle (mprapi.h)
La funzione MprAdminInterfaceGetHandle recupera un handle in un'interfaccia specificata.
Sintassi
DWORD MprAdminInterfaceGetHandle(
[in] MPR_SERVER_HANDLE hMprServer,
[in] LPWSTR lpwsInterfaceName,
[out] HANDLE *phInterface,
[in] BOOL fIncludeClientInterfaces
);
Parametri
[in] hMprServer
Gestire il router su cui eseguire questa chiamata. Ottenere questo handle chiamando MprAdminServerConnect.
[in] lpwsInterfaceName
Puntatore a una stringa Unicode con terminazione null che specifica il nome dell'interfaccia da recuperare.
[out] phInterface
Puntatore a una variabile HANDLE che riceve un handle all'interfaccia specificata da lpwsInterfaceName.
[in] fIncludeClientInterfaces
Specifica se la funzione restituisce un'interfaccia client. Se questo parametro è FALSE, le interfacce di tipo ROUTER_IF_TYPE_CLIENT vengono ignorate nella ricerca dell'interfaccia con il nome specificato da lpwsInterfaceName. Se questo parametro è TRUE e un'interfaccia con il nome specificato esiste, MprAdminInterfaceGetHandle restituisce un handle a un'interfaccia di tipo ROUTER_IF_TYPE_CLIENT. Poiché è possibile che siano presenti diverse interfacce di tipo ROUTER_IF_TYPE_CLIENT, l'handle ha restituito riferimenti alla prima interfaccia trovata con il nome specificato da lpwsInterfaceName.
Valore restituito
Se la funzione ha esito positivo, il valore restituito è NO_ERROR.
Se la funzione ha esito negativo, il valore restituito è uno dei codici di errore seguenti.
| Valore | Significato |
|---|---|
|
L'applicazione chiamante non dispone di privilegi sufficienti. |
|
Nessuna interfaccia esiste con il nome specificato da lpwsInterfaceName. |
|
L'handle passato al server è NULL. |
|
lpwsInterfaceName è NULL. |
Requisiti
| Client minimo supportato | Nessuno supportato |
| Server minimo supportato | Windows 2000 Server [solo app desktop] |
| Piattaforma di destinazione | Windows |
| Intestazione | mprapi.h |
| Libreria | Mprapi.lib |
| DLL | Mprapi.dll |