MprAdminInterfaceConnect 函数 (mprapi.h)

项目
08/24/2023

MprAdminInterfaceConnect 函数创建与指定 WAN 接口的连接。

语法

DWORD MprAdminInterfaceConnect(
  [in] MPR_SERVER_HANDLE hMprServer,
  [in] HANDLE            hInterface,
  [in] HANDLE            hEvent,
  [in] BOOL              fSynchronous
);

parameters

[in] hMprServer

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

[in] hInterface

接口的句柄。此句柄是从上一次调用 MprAdminInterfaceCreate 获取的。

[in] hEvent

在尝试连接接口完成之后发出信号的事件的句柄。函数启动连接尝试并立即返回。发出事件信号后，可以通过调用 MprAdminInterfaceGetInfo 来获取连接尝试的结果。

如果此参数为 NULL 且 fBlocking 为 TRUE，则此调用是同步的，也就是说，函数在连接尝试完成之前不会返回。

如果 hMprServer 指定远程路由器，则调用应用程序必须为此参数指定 NULL。

[in] fSynchronous

如果 hEvent 为 NULL 且此参数设置为 TRUE，则该函数在连接尝试完成之前不会返回。

如果 hEvent 为 NULL，并且此参数设置为 FALSE，则该函数将立即返回。返回值为 PENDING 表示连接尝试已成功启动。

如果 hEvent 不为 NULL，则忽略此参数。

返回值

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

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

值	含义
ERROR_ACCESS_DENIED	调用应用程序没有足够的权限。
ERROR_ALREADY_CONNECTING	此接口上的连接已在进行中。
ERROR_DDM_NOT_RUNNING	(DDM) 的 Demand Dial Manager 未运行。
ERROR_INTERFACE_DISABLED	接口当前已禁用。
ERROR_INTERFACE_HAS_NO_DEVICES	此接口没有可用的适配器。
ERROR_INVALID_HANDLE	hInterface 值无效。
ERROR_SERVICE_IS_PAUSED	按需拨号服务当前已暂停。
等待	接口正在连接。调用应用程序必须等待 hEvent 句柄（如果已指定）。发出事件信号后，可以通过调用 MprAdminInterfaceGetInfo 获取连接状态和任何关联的错误。

注解

下表总结了 hEvent 与 fBlocking 之间的关系。

hEvent	fBlocking	结果
事件句柄	忽略	调用会立即返回。返回值为 PENDING 表示尝试已成功启动。等待 hEvent。收到 hEvent 信号时，请使用 MprAdminInterfaceGetInfo 来确定连接尝试的成功或失败。
NULL	TRUE	在连接尝试完成之前，调用不会返回。
NULL	FALSE	调用会立即返回。返回值为 PENDING 表示尝试已成功启动。

要求


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