MprAdminConnectionEnumEx 函数 (mprapi.h)

项目
02/29/2024

MprAdminConnectionEnumEx 函数枚举指定 RRAS 服务器的活动连接。

语法

DWORD MprAdminConnectionEnumEx(
  [in]  RAS_SERVER_HANDLE     hRasServer,
  [in]  PMPRAPI_OBJECT_HEADER pObjectHeader,
  [in]  DWORD                 dwPreferedMaxLen,
  [out] LPDWORD               lpdwEntriesRead,
  [out] LPDWORD               lpdwTotalEntries,
  [out] PRAS_CONNECTION_EX    *ppRasConn,
  [in]  LPDWORD               lpdwResumeHandle
);

参数

[in] hRasServer

枚举连接的 RAS 服务器的句柄。通过调用 MprAdminServerConnect 获取此句柄。

[in] pObjectHeader

指向 MPRAPI_OBJECT_HEADER 结构的指针，该结构指定 由 ppRasConn 接收的结构版本。

[in] dwPreferedMaxLen

一个值，该值指定返回数据的首选最大长度（以 8 位字节为单位）。如果 dwPrefMaxLen 为 -1，则返回的缓冲区足够大，足以容纳所有可用信息。

[out] lpdwEntriesRead

指向 DWORD 的指针，该 DWORD 接收从当前恢复位置枚举的连接总数。

[out] lpdwTotalEntries

指向 DWORD 的指针，该 DWORD 接收可能从当前恢复位置枚举的连接总数。

[out] ppRasConn

一个指针，在输出上指向包含 hRasServer 中 RRAS 服务器的活动连接信息的RAS_CONNECTION_EX结构数组。数组元素的数量由 lpdwEntriesRead 指向的值决定。

[in] lpdwResumeHandle

指向 DWORD 变量的指针，该变量指定用于继续枚举的恢复句柄。 lpdwResumeHandle 参数在第一次调用时为 NULL，在后续调用中保持不变。如果返回代码 ERROR_MORE_DATA，则可能使用此句柄进行另一个调用来检索更多数据。如果返回时句柄为 NULL ，则枚举已完成。此句柄对于其他类型的错误返回无效。

返回值

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

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

值	含义
ERROR_ACCESS_DENIED	调用应用程序没有足够的权限。
ERROR_DDM_NOT_RUNNING	DDM (DDM) 的 Demand Dial Manager 未运行。
ERROR_MORE_DATA	并非所有数据都是通过此调用返回的。若要获取其他数据，请使用恢复句柄再次调用函数。
ERROR_PROC_NOT_FOUND	找不到指定的过程。
其他	来自 MprError.h、RasError.h 或 WinError.h 的错误。

注解

调用方应通过调用函数 MprAdminBufferFree 来释放 ppRasConn 指向的内存。

要求

要求	值
最低受支持的客户端	Windows 7 [仅限桌面应用]
最低受支持的服务器	Windows Server 2008 R2 [仅限桌面应用]
目标平台	Windows
标头	mprapi.h
Library	Mprapi.lib
DLL	Mprapi.dll