RtmCreateNextHopEnum 函数 (rtmv2.h)
RtmCreateNextHopEnum 枚举下一跃点列表中的下一跃点。
语法
DWORD RtmCreateNextHopEnum(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_ENUM_FLAGS EnumFlags,
[in] PRTM_NET_ADDRESS NetAddress,
[out] PRTM_ENUM_HANDLE RtmEnumHandle
);
parameters
[in] RtmRegHandle
从上一次调用 RtmRegisterEntity 获取的客户端的句柄。
[in] EnumFlags
指定要包含在枚举中的下一跃点。 使用以下标志。
返回的常量 | 含义 |
---|---|
|
枚举从指定地址/掩码长度 ((例如 10/8) )开始的下一跃点。 枚举一直持续到下一跃点列表的末尾。 |
|
枚举地址/掩码长度 (指定的指定范围内的下一跃点,例如 10/8) 。 |
|
枚举从 0/0 开始的下一跃点。 为 NetAddress 指定 NULL。 |
[in] NetAddress
指向包含枚举起始地址 的RTM_NET_ADDRESS 结构的指针。 如果 EnumFlags 包含RTM_ENUM_START,则指定 NULL。
[out] RtmEnumHandle
输入时, RtmEnumHandle 是指向 NULL 的指针。
在输出时, RtmEnumHandle 接收指向枚举句柄的指针。 在对 RtmGetEnumNextHops、 RtmReleaseNextHops 和 RtmDeleteEnumHandle 的所有后续调用中使用此句柄。
返回值
如果函数成功,则返回值NO_ERROR。
如果函数失败,则返回值为以下错误代码之一。
值 | 含义 |
---|---|
|
参数包含不正确的信息。 |
|
内存不足,无法完成此操作。 |
注解
如果 EnumFlags 包含RTM_ENUM_RANGE,请使用 NetAddress 指定要枚举的路由表的范围。 例如,如果客户端将 NetAddress 设置为 10/8,则返回范围 10.0.0.0/8 到 10.255.255.255/32 的下一跃点。
当枚举句柄不再需要时,通过调用 RtmDeleteEnumHandle 释放它。
要求
最低受支持的客户端 | 无受支持的版本 |
最低受支持的服务器 | Windows 2000 Server [仅限桌面应用] |
目标平台 | Windows |
标头 | rtmv2.h |
Library | Rtm.lib |
DLL | Rtm.dll |