MgmGetFirstMfe function (mgm.h)

The MgmGetFirstMfe function retrieves MFEs starting at the beginning of the MFE list. The function can retrieve zero, one, or more MFEs. The number of MFEs returned depends on the size of the MFEs 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.

Syntax

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

Parameters

[in, out] pdwBufferSize

On input, pdwBufferSize is a pointer to a DWORD-sized memory location containing 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 the MFE; 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 MFEs. Each MFE is a MIB_IPMCAST_MFE 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 MFEs contained in pbBuffer.

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 begin sequential retrieval of MFEs; use MgmGetNextMfe to continue the retrieval process.

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

Requirements

See also

MIB_IPMCAST_MFE

MgmGetMfe

MgmGetNextMfe