GetMulticastIpAddressEntry (NETIOAPI) (Compact 2013)

  • Article

3/26/2014

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

Syntax

NETIOAPI_API
  GetMulticastIpAddressEntry(
    IN OUT 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 is updated with the properties for an existing multicast IP address.

Return Value

GetMulticastIpAddressEntry returns STATUS_SUCCESS if the function succeeds.

If the function fails, GetMulticastIpAddressEntry returns one of the following error codes:

Error Code

Meaning

STATUS_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 structure that the Row parameter points to was not set to a valid multicast IPv4 or IPv6 address, or both InterfaceLuid and InterfaceIndex members of the MIB_MULTICASTIPADDRESS_ROW structure were unspecified.

STATUS_NOT_FOUND

The specified interface could not be found. This error is returned if the function cannot find the network interface that is specified by the InterfaceLuid or InterfaceIndex member of the MIB_MULTICASTIPADDRESS_ROW structure that the Row parameter points to.

STATUS_NOT_SUPPORTED

The request is not supported. This error is returned if no IPv4 stack is located on the local device and an IPv4 address was specified in the Address member of the MIB_MULTICASTIPADDRESS_ROW structure that the Row parameter points to, or if no IPv6 stack is located on the local device and an IPv6 address was specified in the Address member.

Other

Use the FormatMessage function 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, your driver must initialize the following members of the MIB_MULTICASTIPADDRESS_ROW structure that the Row parameter points to.

  • Address
    Set to a valid IPv4 or IPv6 address and family.
  • InterfaceLuid or InterfaceIndex
    These members are used in the order that is listed earlier. So if InterfaceLuid is specified, this member is used to determine the interface. If no value was set for the InterfaceLuid member (the value 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 in the MIB_MULTICASTIPADDRESS_ROW structure that the Row parameter points to.

Your driver can call the GetMulticastIpAddressTable (NETIOAPI) function to enumerate the multicast IP address entries on a local device.

See Also

Reference

IP Helper Kernel-Mode Functions
GetMulticastIpAddressTable (NETIOAPI)
MIB_MULTICASTIPADDRESS_ROW
MIB_MULTICASTIPADDRESS_TABLE