Administrative applications call a subset of MGM functions that are related to enumerating multicast forwarding entries (MFEs) and MFE statistics. An application does not need to register with the multicast group manager to use these functions (that is, the application does not need a handle).
Enumerating MFEs
The following table summarizes a series of steps in an interactions between an administrative application and the multicast group manager. The first column describes the actions that the administrative application performs and the administrative application's responses to the multicast group manager. The second column describes the multicast group manager's responses to the administrative application. The third column presents any additional information.
Each row of the table represents one step.
| Administrative application action | Multicast group manager action | Notes |
|---|---|---|
| Obtain one or more MFEs using the MgmGetFirstMfe function. | Return as many MFEs as fit in the buffer supplied by the client. If no MFEs can be returned in the supplied buffer, return ERROR_INSUFFICIENT_BUFFER and the size of the buffer that is needed to return one MFE. | Clients can also retrieve MFE statistics using the corresponding statistics functions, MgmGetFirstMfeStats and MgmGetNextMfeStats. |
| If ERROR_INSUFFICIENT_BUFFER is received, call the MgmGetFirstMfe function again using a buffer of the size indicated. | ||
| Continue calling the MgmGetNextMfe function, supplying as one of the parameters the last MFE that was returned by the previous call to the MgmGetFirstMfe function. | Return as many MFEs as fit in the buffer supplied by the client. If no MFEs can be returned in the supplied buffer, return ERROR_INSUFFICIENT_BUFFER and the size of the buffer that is needed for one MFE. Return ERROR_NO_MORE_ITEMS when no more MFEs remain. | |
| Continue the enumeration until ERROR_NO_MORE_ITEMS is received. |
Note:
Use the MgmGetMfe and MgmGetMfeStats functions to retrieve a specific MFE or specific set of MFE statistics.
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
