MprAdminInterfaceGetHandle

[This is preliminary documentation and subject to change.]

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
);

Parameters

hMprServer

Handle to the Windows NT router on which this call will be executed. Obtain this handle by calling MprAdminServerConnect.

lpwsInterfaceName

Pointer to a Unicode string that contains the name of the interface to be retrieved.

phInterface

Pointer to a HANDLE variable that, on successful return, will contain a handle to the interface specified by lpwsInterfaceName.

fIncludeClientInterfaces

If this parameter is FALSE, interfaces of type ROUTER_IF_TYPE_CLIENT will be ignored in the search for the interface with the name specified by lpwsInterfaceName. If this parameter is TRUE, a handle to an interface of type ROUTER_IF_TYPE_CLIENT may be returned. Since it is possible that there are several interfaces of type ROUTER_IF_TYPE_CLIENT, the handle returned will be for the first interface found with the name specified by lpwsInterfaceName.

Return Values

NO_ERROR

Success

ERROR_ACCESS_DENIED

The caller does not have sufficient privilege.

ERROR_INVALID_PARAMETER

lpwsInterfaceName is NULL.

ERROR_NO_SUCH_INTERFACE

No interface exists with the name specified by lpwsInterfaceName.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in mprapi.h.
  Import Library: Link with mprapi.lib.

See Also

ROUTER_INTERFACE_TYPE, MprAdminServerConnect