rtmGetEnumDests 函数 (rtmv2.h)

RtmGetEnumDests 函数检索指定枚举中的下一组目标。

语法

DWORD RtmGetEnumDests(
  [in]      RTM_ENTITY_HANDLE RtmRegHandle,
  [in]      RTM_ENUM_HANDLE   EnumHandle,
  [in, out] PUINT             NumDests,
  [out]     PRTM_DEST_INFO    DestInfos
);

parameters

[in] RtmRegHandle

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

[in] EnumHandle

目标枚举的句柄。

[in, out] NumDests

输入时, NumDests 是指向 UINT 值的指针,该值指定 DestInfos 可以接收的最大目标数。 在输出时, NumDests 接收 DestInfos 接收的实际目标数。

[out] DestInfos

在输入时, DestInfos 是指向 RTM_DEST_INFO 结构的指针。

在输出时, DestInfos 接收指向目标的句柄数组。

返回值

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

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

含义
ERROR_INVALID_PARAMETER
NumRoutes 指向的值大于允许客户端通过一次调用检索的最大路由数。 检查 RTM_REGN_PROFILE ,了解允许客户端通过一次调用检索的最大目标数。
ERROR_NO_MORE_ITEMS
没有更多要枚举的目标。
 
 

注解

DestInfos 指向的结构是一个大小可变的结构。 如果客户端使用 TargetViews 指定多个视图,则每个视图的 DestInfos 大小都会增加。 使用 RTM_SIZE_OF_DEST_INFO 宏确定在调用此函数之前要分配 的 DestInfos 结构的大小。 使用为 TargetViews 指定的值作为参数来 RTM_SIZE_OF_DEST_INFO

当不再需要目标时,通过调用 RtmReleaseDests 来释放它们。

有关使用此函数的示例代码,请参阅 枚举所有目标

要求

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

请参阅

RTM_DEST_INFO

RtmCreateDestEnum

RtmDeleteEnumHandle

RtmReleaseDests