MprConfigInterfaceTransportEnum 函数 (mprapi.h)

项目
08/24/2023

MprConfigInterfaceTransportEnum 函数枚举在指定接口上配置的传输。

语法

DWORD MprConfigInterfaceTransportEnum(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterInterface,
  [in]                DWORD   dwLevel,
  [in, out]           LPBYTE  *lplpBuffer,
  [in]                DWORD   dwPrefMaxLen,
  [out]               LPDWORD lpdwEntriesRead,
  [out]               LPDWORD lpdwTotalEntries,
  [in, out, optional] LPDWORD lpdwResumeHandle
);

parameters

[in] hMprConfig

路由器配置的句柄。通过调用 MprConfigServerConnect 获取此句柄。

[in] hRouterInterface

要从中枚举传输的接口配置的句柄。通过调用 MprConfigInterfaceCreate 或 MprConfigInterfaceEnum 获取此句柄。

[in] dwLevel

一个 DWORD 值，该值描述在 lplpBuffer 参数中返回信息的格式。必须为零。

[in, out] lplpBuffer

输入时为非 NULL 指针。

成功完成后，指向 MPR_IFTRANSPORT_0 结构的数组的指针。通过调用 MprConfigBufferFree 释放此内存缓冲区。

[in] dwPrefMaxLen

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

[out] lpdwEntriesRead

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

[out] lpdwTotalEntries

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

[in, out, optional] lpdwResumeHandle

指向 DWORD 变量的指针。

输入时，第一次调用的句柄应为零，在后续调用中保持不变。

在输出时，此变量包含用于继续枚举的恢复句柄。如果句柄为 NULL，则枚举完成。

如果枚举中发生错误，则此句柄无效。

此参数是可选的。如果调用应用程序为此参数指定 NULL ，则该函数不会返回恢复句柄。

返回值

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

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

值	含义
ERROR_INVALID_PARAMETER	下列情况之一存在： hMprConfig 为 NULL。 HRouterInterface 为 NULL。 dwLevel 不是零。 lplpBuffer 为 NULL。 dwPrefMaxLen 小于单个 MPR_IFTRANSPORT_0 结构的大小。 lpdwEntriesRead 为 NULL。 lpdwTotalEntries 为 NULL。
ERROR_NOT_ENOUGH_MEMORY	资源不足，无法完成操作。
ERROR_NO_MORE_ITEMS	当前简历位置中不再有可用的条目。
其他	使用 FormatMessage 检索与返回的错误代码对应的系统错误消息。

要求


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