MprAdminInterfaceGetHandle 函数 (mprapi.h)

  • 项目

MprAdminInterfaceGetHandle 函数检索指定接口的句柄。

语法

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

parameters

[in] hMprServer

要对其执行此调用的路由器的句柄。 通过调用 MprAdminServerConnect 获取此句柄。

[in] lpwsInterfaceName

指向以 null 结尾的 Unicode 字符串的指针，该字符串指定要检索的接口的名称。

[out] phInterface

指向 HANDLE 变量的指针，该变量接收 由 lpwsInterfaceName 指定的接口的句柄。

[in] fIncludeClientInterfaces

指定函数是否返回客户端接口。 如果此参数为 FALSE，则搜索具有 lpwsInterfaceName 指定名称的接口时，将忽略 ROUTER_IF_TYPE_CLIENT 类型的接口。 如果此参数为 TRUE 并且存在具有指定名称的接口， 则 MprAdminInterfaceGetHandle 将返回 ROUTER_IF_TYPE_CLIENT类型的接口的句柄。 由于可能有多个 ROUTER_IF_TYPE_CLIENT类型的接口，因此句柄返回引用了使用 lpwsInterfaceName 指定的名称找到的第一个接口。

返回值

如果函数成功，则返回值 NO_ERROR。

如果函数失败，则返回值为以下错误代码之一。

值 含义
ERROR_ACCESS_DENIED
 调用应用程序没有足够的权限。
ERROR_NO_SUCH_INTERFACE
 不存在名称由 lpwsInterfaceName 指定的接口。
RPC_S_INVALID_BINDING
 传入服务器的句柄为 NULL。
RPC_X_NULL_REF_POINTER
 lpwsInterfaceName 为 NULL。
 
 

要求

   
最低受支持的客户端 无受支持的版本
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
目标平台 Windows
标头 mprapi.h
Library Mprapi.lib
DLL Mprapi.dll

另请参阅

MprAdminServerConnect

ROUTER_INTERFACE_TYPE

路由器管理功能

路由器管理参考