Share via

GetMulticastIpAddressEntry (Compact 2013)

  • Article

3/26/2014

This function retrieves information for an existing multicast IP address entry on the local device.

Syntax

NETIOAPI_API GetMulticastIpAddressEntry(
  __inout  PMIB_MULTICASTIPADDRESS_ROW Row
);

Parameters

  • Row
    A pointer to a MIB_MULTICASTIPADDRESS_ROW structure entry for a multicast IP address entry. On successful return, this structure will be updated with the properties for an existing multicast IP address.

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.

Return code

Description

ERROR_INVALID_PARAMETER

An invalid parameter was passed to the function. This error is returned if a NULL pointer is passed in the Row parameter, the Address member of the MIB_MULTICASTIPADDRESS_ROW pointed to by the Row parameter was not set to a valid multicast IPv4 or IPv6 address, or both the InterfaceLuid or InterfaceIndex members of the MIB_MULTICASTIPADDRESS_ROW pointed to by the Row parameter were unspecified.

ERROR_NOT_FOUND

The specified interface could not be found. This error is returned if the network interface specified by the InterfaceLuid or InterfaceIndex member of the MIB_MULTICASTIPADDRESS_ROW pointed to by the Row parameter could not be found.

ERROR_NOT_SUPPORTED

The request is not supported. This error is returned if no IPv4 stack is on the local device and an IPv4 address was specified in the Address member MIB_MULTICASTIPADDRESS_ROW pointed to by the Row parameter. This error is also returned if no IPv6 stack is on the local device and an IPv6 address was specified in the Address member.

Other

Use FormatMessage to obtain the message string for the returned error.

Remarks

The GetMulticastIpAddressEntry function is used to retrieve an existing MIB_MULTICASTIPADDRESS_ROW structure entry.

On input, the Address member in the MIB_MULTICASTIPADDRESS_ROW structure pointed to by the Row parameter must be initialized to a valid multicast IPv4 or IPv6 address and family. In addition, at least one of the following members in the MIB_MULTICASTIPADDRESS_ROW structure pointed to the Row parameter must be initialized: the InterfaceLuid or InterfaceIndex. The fields are used in the order listed earlier. So if the InterfaceLuid is specified, this member is used to determine the interface. If no value was set for the InterfaceLuid member (the values of this member was set to zero), the InterfaceIndex member is next used to determine the interface.

On output when the call is successful, GetMulticastIpAddressEntry retrieves the other properties for the multicast IP address and fills out the MIB_MULTICASTIPADDRESS_ROW structure pointed to by the Row parameter.

The GetMulticastIpAddressTable function can be called to enumerate the multicast IP address entries on a local device.

See Also

Reference

IP Helper Functions
GetMulticastIpAddressTable
MIB_MULTICASTIPADDRESS_ROW
MIB_MULTICASTIPADDRESS_TABLE