MprAdminPortEnum 函数 (mprapi.h)
MprAdminPortEnum 函数枚举特定连接中的所有活动端口,或者可供 RAS 使用或当前使用的所有端口。
语法
DWORD MprAdminPortEnum(
[in] RAS_SERVER_HANDLE hRasServer,
[in] DWORD dwLevel,
[in] HANDLE hRasConnection,
[out] LPBYTE *lplpbBuffer,
[in] DWORD dwPrefMaxLen,
[out] LPDWORD lpdwEntriesRead,
[out] LPDWORD lpdwTotalEntries,
[in] LPDWORD lpdwResumeHandle
);
参数
[in] hRasServer
要枚举其端口的 RAS 服务器的句柄。 若要获取此句柄,请调用 MprAdminServerConnect。
[in] dwLevel
一个 DWORD 值,该值描述 在 lplpbBuffer 参数中返回信息的格式。 必须为零。
[in] hRasConnection
为其枚举活动端口的连接句柄。 如果此参数 INVALID_HANDLE_VALUE,则枚举 RRAS 使用或可供使用的所有端口。 若要获取此句柄,请调用 MprAdminConnectionEnum。
[out] lplpbBuffer
成功完成后,指向描述端口的 RAS_PORT_0 结构的数组的指针。 通过调用 MprAdminBufferFree 释放此内存。
[in] dwPrefMaxLen
一个 值,该值指定返回数据的首选最大长度(以 8 位字节为单位)。 如果此参数为 -1,则返回的缓冲区足够大,足以容纳所有可用数据。
[out] lpdwEntriesRead
指向 DWORD 变量的指针。 此变量接收从当前恢复位置枚举的端口总数。
[out] lpdwTotalEntries
指向 DWORD 变量的指针。 此变量接收可从当前恢复位置枚举的端口总数。
[in] lpdwResumeHandle
指向 DWORD 变量的指针。 成功执行后,此参数指定可用于恢复枚举的句柄。 此参数在第一次调用时应为零,在后续调用中保持不变。 如果返回代码 ERROR_MORE_DATA,可以使用 句柄重新发出调用以检索更多数据。 如果返回时句柄为 NULL ,则无法继续枚举。 此句柄对于其他类型的错误返回无效。
返回值
如果函数成功,则返回值 NO_ERROR。
如果函数失败,则返回值是下表中列出的错误代码之一。
值 | 含义 |
---|---|
|
调用应用程序没有足够的权限。 |
|
Demand Dial Manager (DDM) 未运行,可能是因为动态接口管理器 (DIM) 配置为仅在 LAN 上运行。 |
|
以下参数中至少有一个为 NULL 或未指向有效内存: lplpBuffer、 lpdwEntriesRead 或 lpdwTotalEntries。 |
|
并非所有数据都是通过此调用返回的。 若要获取其他数据,请使用 IpdwResumeHandle 参数中返回的句柄再次调用函数。 |
|
dwLevel 参数不为零。 |
|
hConnection 参数为 NULL。 |
|
来自 MprError.h、RasError.h 或 WinError.h 的错误。 |
注解
如果安装了 RRAS 可再发行组件,则此函数在 Windows NT 4.0 上可用。 但是,RRAS 可再发行组件随附的 Mprapi.dll 版本将函数导出为 RasAdminPortEnum ,而不是 MprAdminPortEnum。 因此,使用 RRAS 可再发行组件时,请使用 LoadLibrary 和 GetProcAddress 访问此函数。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows 2000 Professional [仅限桌面应用] |
最低受支持的服务器 | Windows 2000 Server [仅限桌面应用] |
目标平台 | Windows |
标头 | mprapi.h |
Library | Mprapi.lib |
DLL | Mprapi.dll |