Share via

mgmGetFirstMfeStats 函数 (mgm.h)

  • 项目

MgmGetFirstMfeStats 函数从 MFE 列表的开头开始检索 MFE 统计信息。 函数可以检索零组、一组或多组 MFE 统计信息。 返回的集数取决于条目的大小以及调用函数时客户端提供的缓冲区的大小。

缓冲区中返回的数据先按组排序，然后按组中的源排序。 返回的统计信息包括每个传出接口上接收的数据包、接收的字节数和转发的数据包。

语法

DWORD MgmGetFirstMfeStats(
  [in, out] PDWORD pdwBufferSize,
  [in, out] PBYTE  pbBuffer,
  [in, out] PDWORD pdwNumEntries,
            DWORD  dwFlags
);

参数

[in, out] pdwBufferSize

在输入时，pdwBufferSize 是指向包含 pbBuffer 大小的 DWORD 大小的内存位置的指针。

在输出中，如果返回值ERROR_INSUFFICIENT_BUFFER， 则 pdwBufferSize 接收最小大小 pbBuffer 必须用于保存一组 MFE 统计信息;否则， pdwBufferSize 的值保持不变。

[in, out] pbBuffer

输入时，客户端必须提供指向缓冲区的指针。

输出时， pbBuffer 包含一组或多组 MFE 统计信息。 每组 MFE 统计信息都是一个 MIB_IPMCAST_MFE_STATS 结构。

[in, out] pdwNumEntries

输入时，客户端必须提供指向 DWORD 大小的内存位置的指针。

输出时， pdwNumEntries 接收 pbBuffer 中包含的 MFE 统计信息集数。

dwFlags

确定返回的数据结构。

值 含义
MGM_MFE_STATS_0
 包括与 MIB_IPMCAST_MFE_STATS对应的统计信息。
MGM_MFE_STATS_1
 包括与 MIB_IPMCAST_MFE_STATS_EX对应的统计信息。

返回值

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

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

值 含义
ERROR_CAN_NOT_COMPLETE
 无法完成对此函数的调用。
ERROR_INSUFFICIENT_BUFFER
 指定的缓冲区太小，即使是一组 MFE 统计信息也是如此。 客户端应检查 pdwBufferSize 的值，以获取检索一组统计信息所需的最小缓冲区大小。
ERROR_MORE_DATA
 提供了更多 MFE 统计信息。
ERROR_NO_MORE_ITEMS
 不再提供 MFE 统计信息。 返回零个或多个 MFE 统计信息集;检查 pdwNumEntries 的值，以验证返回的统计信息集数。

注解

此函数用于开始按顺序检索 MFE 统计信息;使用 MgmGetNextMfeStats 继续检索过程。

通常，若要检索 MFE 统计信息，请先调用 MgmGetFirstMfeStats。 然后，调用 MgmGetNextMfeStats 一次或多次，直到没有更多要返回的 MFE。 每次对 MgmGetNextMfeStats 的 调用应在上次调用 MgmGetNextMfeStats 返回的最后一个 MFE (或对 MgmGetFirstMfeStats 的初始调用之后开始，) 为此，客户端在上一次调用返回的缓冲区中指定最后一个源和组。

MFE 统计信息以 dwFlags 参数确定的MIB_IPMCAST_MFE_STATS或MIB_IPMCAST_MFE_STATS_EX结构返回。

注意pbBuffer 指向的缓冲区的最小大小不是固定的;对于每组 MFE 统计信息，它都是不同的。 使用 sizeof 宏确定缓冲区中返回的每组统计信息的大小。
 

要求

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

另请参阅

MIB_IPMCAST_MFE_STATS

MIB_IPMCAST_MFE_STATS_EX

MgmGetMfeStats

MgmGetNextMfeStats