IBDA_IPSinkInfo::get_MulticastList Method

Article
01/07/2009

This interface is available for use in the Microsoft Windows 2000, Windows XP, and Windows Server 2003 operating systems. It may be altered or unavailable in subsequent versions.
The get_MulticastList method retrieves a list of the multicast addresses to which the IP Sink filter is listening. This method returns a list of IP addresses in 6-byte IEEE 802.3 format; the list is returned as an array of bytes.

Syntax

HRESULT get_MulticastList(
  [out]  ULONG *pulcbAddresses,
  [out]  BYTE **ppbAddressList
);

Parameters

pulcbAddresses [out]
Receives the number of bytes in the returned array.
ppbAddressList [out]
Pointer to variable that receives an array of bytes, of size *pulcbAddresses. Each IP address is 6 consecutive bytes.

Return Value

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

Remarks

The method allocates the memory for the array. The caller must free the memory by calling CoTaskMemFree.

Requirements

Header

Declared in Bdaiface.h.