IBDA_EthernetFilter::GetMulticastList Method

The GetMulticastList method retrieves the list of multicast addresses on the Network Provider.

Syntax

HRESULT GetMulticastList(
  [in, out]  ULONG *ulcbAddresses,
  [out]      BYTE pAddressList[]
);

Parameters

  • ulcbAddresses [in, out]
    On input, specifies the maximum number of addresses to retrieve, multiplied by the number of bytes per address. On output, receives the actual number of bytes retrieved.

  • pAddressList [out]
    Pointer that receives an array of addresses whose size in bytes is equal to ulcbAddresses. See Remarks.

Return Value

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

The declaration of pAddressList is not COM compliant. As a workaround, the client should allocate the pAddressList buffer. The buffer should be the same size as advertised in the pulcbAddresses parameter. The network provider will just fill in the buffer allocated by the caller.

Requirements

Header Declared in Bdaiface.h.

See Also

Error and Success Codes
IBDA_EthernetFilter Interface

Send comments about this topic to Microsoft

Build date: 12/4/2008