Edit

Share via

MgmGetMfeStats function (mgm.h)

  • Article

The MgmGetMfeStats function retrieves the statistics for a specific MFE. The statistics returned include the packets received, bytes received, and the packets forwarded on each outgoing interface.

Syntax

DWORD MgmGetMfeStats(
  [in]      PMIB_IPMCAST_MFE pimm,
  [in, out] PDWORD           pdwBufferSize,
  [in, out] PBYTE            pbBuffer,
            DWORD            dwFlags
);

Parameters

[in] pimm

Pointer to a MIB_IPMCAST_MFE structure that specifies the MFE for which to retrieve statistics. The information to be returned is indicated by the dwSource and dwGroup members of the MIB_IPMCAST_MFE structure.

[in, out] pdwBufferSize

On input, pdwBufferSize is a pointer to a DWORD-sized memory location that contains the size, in bytes, of the buffer pointed to by pbBuffer.

On output, if the return value is ERROR_INSUFFICIENT_BUFFER, pdwBufferSize receives the minimum size the buffer pointed to by pbBuffer must be to hold the set of MFE statistics; otherwise the value of pdwBufferSize remains unchanged.

[in, out] pbBuffer

On input, the client must supply a pointer to a buffer.

On output, pbBuffer contains the specified set of MFE statistics.

dwFlags

Determines the data structure returned.

Value Meaning
MGM_MFE_STATS_0
 Include statistics corresponding to MIB_IPMCAST_MFE_STATS.
MGM_MFE_STATS_1
 Include statistics corresponding to MIB_IPMCAST_MFE_STATS_EX.

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

Value Meaning
ERROR_CAN_NOT_COMPLETE
 Could not complete the call to this function.
ERROR_INSUFFICIENT_BUFFER
 The specified buffer is too small for the statistics for even one MFE. The client should check the value of pdwBufferSize for the minimum buffer size required to retrieve statistics for one MFE.
ERROR_NOT_FOUND
 The specified MFE was not found.

Remarks

The MFE statistics are returned in either an MIB_IPMCAST_MFE_STATS or MIB_IPMCAST_MFE_STATS_EX structure determined by the dwFlags parameter.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header mgm.h
Library Rtm.lib
DLL Rtm.dll

See also

MIB_IPMCAST_MFE_STATS

MIB_IPMCAST_MFE_STATS_EX

MgmGetFirstMfeStats

MgmGetNextMfeStats