通过

rtmGetEnumRoutes 函数 (rtmv2.h)

  • 项目

RtmGetEnumRoutes 函数检索指定枚举中的下一组路由。

语法

DWORD RtmGetEnumRoutes(
  [in]      RTM_ENTITY_HANDLE RtmRegHandle,
  [in]      RTM_ENUM_HANDLE   EnumHandle,
  [in, out] PUINT             NumRoutes,
  [out]     PRTM_ROUTE_HANDLE RouteHandles
);

参数

[in] RtmRegHandle

从上一次调用 RtmRegisterEntity 获取的客户端的句柄。

[in] EnumHandle

路由枚举的句柄。

[in, out] NumRoutes

输入时， NumRoutes 是指向 UINT 值的指针，该值指定 RouteHandles 可以接收的最大路由数。

输出时， NumRoutes 接收 RouteHandles 接收的实际路由数。

[out] RouteHandles

输入时， RouteHandles 是指向 RTM_ROUTE_INFO 结构的指针。

在输出时， RouteHandles 接收路由的句柄数组。

返回值

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

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

值 含义
ERROR_INVALID_PARAMETER
 NumRoutes 指向的值大于允许客户端通过一次调用检索的最大路由数。 检查 RTM_REGN_PROFILE ，了解允许客户端通过一次调用检索的最大路由数。
ERROR_NO_MORE_ITEMS
 没有更多要枚举的路由。
ERROR_NOT_ENOUGH_MEMORY
 内存不足，无法完成此操作。
 
 

注解

如果不再需要路由，请通过调用 RtmReleaseRoutes 来释放这些路由。

有关使用此函数的示例代码，请参阅 枚举所有路由。

要求

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

另请参阅

RtmCreateRouteEnum

RtmDeleteEnumHandle

RtmReleaseRoutes