RasGetSubEntryHandleA 函数 (ras.h)
RasGetSubEntryHandle 函数检索多链接连接的指定子项的连接句柄。
语法
DWORD RasGetSubEntryHandleA(
[in] HRASCONN unnamedParam1,
[in] DWORD unnamedParam2,
[out] LPHRASCONN unnamedParam3
);
参数
[in] unnamedParam1
指定多链接电话簿条目的 RasDial 函数返回的 HRASCONN 连接句柄。
[in] unnamedParam2
指定电话簿条目的有效子项索引。
[out] unnamedParam3
指向 HRASCONN 变量的指针,该变量接收表示子项连接的连接句柄。
返回值
如果函数成功,则返回值 ERROR_SUCCESS。
如果函数失败,则返回值是以下错误代码之一或来自 路由和远程访问错误代码 或 Winerror.h 的值。
价值 | 意义 |
---|---|
|
hRasConn 连接句柄不表示连接的电话簿条目。 |
|
hRasConn 和 dwSubEntry 参数有效,但指定的子项未连接。 |
|
dwSubEntry 指定的值超过了电话簿条目的最大子项数。 |
言论
hRasConn 参数中指定的连接句柄是指整个多链接连接,但在 *lphRasConn 参数中返回的连接句柄仅引用子连接。 在任何接受 hRasConn 参数的函数中使用子项连接句柄,包括 RasHangUp、RasGetConnectStatus和 RasGetProjectionInfoEx 函数。 RasGetProjectionInfo 为多链接项返回的投影信息对于每个子项的连接句柄都是相同的,因为它适用于主连接句柄。
可以在 RasGetSubEntryHandle 返回的句柄上调用 RasHangUp,以终止多链接连接中的单个链接。 但是,不能使用 RasGetConnectStatus 来确定链接是否终止;即使链接已成功终止,RasGetConnectStatus 也可能不会返回ERROR_INVALID_HANDLE。
注意
ras.h 标头将 RasGetSubEntryHandle 定义为一个别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将中性编码别名与不中性编码的代码混合使用可能会导致编译或运行时错误不匹配。 有关详细信息,请参阅函数原型的
要求
要求 | 价值 |
---|---|
最低支持的客户端 | Windows 2000 Professional [仅限桌面应用] |
支持的最低服务器 | Windows 2000 Server [仅限桌面应用] |
目标平台 | 窗户 |
标头 | ras.h |
库 | Rasapi32.lib |
DLL | Rasapi32.dll |