Edit

MgmGetMfe function (mgm.h)

  • Article

The MgmGetMfe function retrieves a specific MFE.

Syntax

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

Parameters

[in] pimm

Pointer to a MIB_IPMCAST_MFE structure that specifies the MFE to retrieve. 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 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 the specified MFE. The MFE is a MIB_IPMCAST_MFE structure.

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 to hold the MFE. The client should check the value of pdwBufferSize for the minimum buffer size required to retrieve the MFE.
ERROR_NOT_FOUND
 The specified MFE was not found.

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

MgmGetFirstMfe

MgmGetNextMfe