The MprAdminInterfaceGetHandle function retrieves a handle to a specified interface.
DWORD MprAdminInterfaceGetHandle(
MPR_SERVER_HANDLE hMprServer, // handle to router
LPWSTR lpwsInterfaceName, // name of interface
HANDLE *phInterface, // handle to interface
BOOL fIncludeClientInterfaces // toggles inclusion of
// client interfaces
);
If the function succeeds, the return value is NO_ERROR.
If the function fails, the return value is one of the following error codes.
| Value | Meaning |
|---|---|
| ERROR_ACCESS_DENIED | The calling application does not have sufficient privileges. |
| ERROR_INVALID_PARAMETER | lpwsInterfaceName is NULL. |
| ERROR_NO_SUCH_INTERFACE | No interface exists with the name specified by lpwsInterfaceName. |
Windows NT/2000: Requires Windows 2000.
Header: Declared in Mprapi.h.
Library: Use Mprapi.lib.
Router Management Reference, Router Administration Functions, ROUTER_INTERFACE_TYPE, MprAdminServerConnect