MgmGetNextMfeStats function (mgm.h)

The MgmGetNextMfeStats function retrieves one or more sets of MFE statistics. The routing table manager starts retrieving statistics starting with the MFE that follows the specified MFE. The function can retrieve zero, one, or more sets of MFE statistics. The number of sets returned depends on the size of the entries and the size of the buffer supplied by the client when the function is called.

The data returned in the buffer is ordered first by group, and then by the sources within a group. The statistics returned include the packets received, bytes received, and packets forwarded on each outgoing interface.

Syntax

DWORD MgmGetNextMfeStats(
  [in]      PMIB_IPMCAST_MFE pimmStart,
  [in, out] PDWORD           pdwBufferSize,
  [in, out] PBYTE            pbBuffer,
  [in, out] PDWORD           pdwNumEntries,
            DWORD            dwFlags
);

Parameters

[in] pimmStart

Pointer to a MIB_IPMCAST_MFE structure that specifies from where to begin retrieving MFE statistics. The dwSource and dwGroup members of the MIB_IPMCAST_MFE structure identify an MFE. Specify the source and group of the last MFE that was returned by the previous call to MgmGetFirstMfeStats or MgmGetNextMfeStats.

[in, out] pdwBufferSize

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

On output, if the return value is ERROR_INSUFFICIENT_BUFFER, pdwBufferSize receives the minimum size pbBuffer must be to hold a 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 one or more sets of MFE statistics. Each set of MFE statistics is a MIB_IPMCAST_MFE_STATS structure.

[in, out] pdwNumEntries

On input, the client must supply a pointer to a DWORD-sized memory location.

On output, pdwNumEntries receives the number of sets of MFE statistics contained in pbBuffer.

dwFlags

Determines the data structure returned.

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.

Remarks

This function is used to continue the sequential retrieval of MFE statistics; use MgmGetFirstMfeStats to start the retrieval process.

In general, to retrieve MFE statistics, first call MgmGetFirstMfeStats. Then, call MgmGetNextMfeStats one or more times, until there are no more MFEs to return. Each call to MgmGetNextMfeStats should begin after the last MFE returned by the previous call to MgmGetNextMfeStats (or the initial call to MgmGetFirstMfeStats) To do this, the client specifies the last source and group in the buffer returned by a previous call.

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

See also

MIB_IPMCAST_MFE_STATS

MIB_IPMCAST_MFE_STATS_EX

MgmGetFirstMfeStats

MgmGetMfeStats