GetUnicastIpAddressEntry (Compact 2013)
3/26/2014
This function retrieves information for an existing unicast IP address entry on the local device.
Syntax
NETIOAPI_API GetUnicastIpAddressEntry(
__inout PMIB_UNICASTIPADDRESS_ROW Row
);
Parameters
- Row
A pointer to a MIB_UNICASTIPADDRESS_ROW structure entry for a unicast IP address entry. On successful return, this structure will be updated with the properties for an existing unicast 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_UNICASTIPADDRESS_ROW pointed to by the Row parameter was not set to a valid unicast IPv4 or IPv6 address, or both the InterfaceLuid and InterfaceIndex members of the MIB_UNICASTIPADDRESS_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_UNICASTIPADDRESS_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_UNICASTIPADDRESS_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 GetUnicastIpAddressEntry function is usually used to retrieve an existing MIB_UNICASTIPADDRESS_ROW structure entry to be modified. An application can then change the members in the MIB_UNICASTIPADDRESS_ROW entry it wishes to modify, and then call the SetUnicastIpAddressEntry function.
On input, the Address member in the MIB_UNICASTIPADDRESS_ROW structure pointed to by the Row parameter must be initialized to a valid unicast IPv4 or IPv6 address and family. In addition, at least one of the following members in the MIB_UNICASTIPADDRESS_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, GetUnicastIpAddressEntry retrieves the other properties for the unicast IP address and fills out the MIB_UNICASTIPADDRESS_ROW structure pointed to by the Row parameter.
The GetUnicastIpAddressTable function can be called to enumerate the unicast IP address entries on a local device.
See Also
Reference
IP Helper Functions
CreateUnicastIpAddressEntry
DeleteUnicastIpAddressEntry
GetUnicastIpAddressTable
InitializeUnicastIpAddressEntry
MIB_UNICASTIPADDRESS_ROW
MIB_UNICASTIPADDRESS_TABLE
NotifyUnicastIpAddressChange
SetUnicastIpAddressEntry