Export (0) Print
Expand All

MgmGetMfe function

The MgmGetMfe function retrieves a specific MFE.

Syntax


DWORD MgmGetMfe(
  _In_     PMIB_IPMCAST_MFE pimm,
  _Inout_  PDWORD pdwBufferSize,
  _Inout_  PBYTE pbBuffer
);

Parameters

pimm [in]

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.

pdwBufferSize [in, out]

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.

pbBuffer [in, out]

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.

ValueMeaning
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

Minimum supported client

None supported

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Mgm.h

Library

Rtm.lib

DLL

Rtm.dll

See also

MgmGetFirstMfe
MgmGetNextMfe
MIB_IPMCAST_MFE

 

 

Community Additions

ADD
Show:
© 2014 Microsoft