MprAdminConnectionEnum 函数 (mprapi.h)

项目
08/24/2023

MprAdminConnectionEnum 函数枚举所有活动连接。

语法

DWORD MprAdminConnectionEnum(
  [in]  RAS_SERVER_HANDLE hRasServer,
  [in]  DWORD             dwLevel,
  [out] LPBYTE            *lplpbBuffer,
  [in]  DWORD             dwPrefMaxLen,
  [out] LPDWORD           lpdwEntriesRead,
  [out] LPDWORD           lpdwTotalEntries,
  [in]  LPDWORD           lpdwResumeHandle
);

参数

[in] hRasServer

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

[in] dwLevel

一个 DWORD 值，该值描述 在 lplpbBuffer 参数中返回信息的格式。 dwLevel 的可接受值包括 0、1、2 和 3，如下表所示。

Windows NT 4.0：此参数必须为零。

值	结构格式
0	RAS_CONNECTION_0
1	Windows 2000 或更高版本： RAS_CONNECTION_1
2	Windows 2000 或更高版本： RAS_CONNECTION_2
3	Windows Server 2008 或更高版本： RAS_CONNECTION_3

[out] lplpbBuffer

成功完成后，指向描述连接的结构的数组的指针。这些结构的类型RAS_CONNECTION_0、 RAS_CONNECTION_1、 RAS_CONNECTION_2或 RAS_CONNECTION_3，具体取决于 dwLevel 参数的值。

若要释放此内存，请调用 MprAdminBufferFree。

[in] dwPrefMaxLen

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

[out] lpdwEntriesRead

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

[out] lpdwTotalEntries

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

[in] lpdwResumeHandle

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

返回值

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

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

值	含义
ERROR_DDM_NOT_RUNNING	Demand Dial Manager (DDM) 未运行，可能是因为动态接口管理器 (DIM) 配置为仅在 LAN 上运行。
ERROR_INVALID_LEVEL	为 dwLevel 传递的值不是零、1、2 或 3。级别 1 和 2 仅在 Windows 2000 或更高版本上受支持。级别 3 仅在 Windows Server 2008 或更高版本上受支持。
ERROR_INVALID_PARAMETER	以下参数中至少有一个为 NULL 或未指向有效内存： lplpBuffer、 lpdwEntriesRead 或 lpdwTotalEntries。
ERROR_MORE_DATA	并非所有数据都是通过此调用返回的。若要获取其他数据，请使用恢复句柄再次调用函数。
RPC_S_INVALID_BINDING	在 hRasServer 参数中传递的句柄为 NULL 或无效。
其他	来自 MprError.h、RasError.h 或 WinError.h 的错误。

注解

如果安装了 RRAS 可再发行组件，则此函数在 Windows NT 4.0 上可用。但是，RRAS 可再发行组件附带的 Mprapi.dll 版本将函数导出为 RasAdminConnectionEnum ，而不是 MprAdminConnectionEnum。因此，使用 RRAS 可再发行组件时，请使用 LoadLibrary 和 GetProcAddress 访问此函数。

要求

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