CreateAnycastIpAddressEntry (Compact 2013)
3/26/2014
This function adds a new anycast IP address entry on the local device.
Syntax
NETIOAPI_API CreateAnycastIpAddressEntry(
__in const MIB_ANYCASTIPADDRESS_ROW* Row
);
Parameters
- Row
A pointer to a MIB_ANYCASTIPADDRESS_ROW structure entry for an anycast IP address entry.
Return Value
Return code |
Description |
|---|---|
NO_ERROR |
The function succeeds |
ERROR_ACCESS_DENIED |
Access is denied. This error is returned under several conditions that include the following: the user lacks the required administrative credentials on the local device or the application is not running in an improved shell as the built-in Administrator (RunAs administrator). |
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_ANYCASTIPADDRESS_ROW pointed to by the Row parameter was not set to a valid unicast IPv4 or IPv6 address, or both the InterfaceLuid or InterfaceIndex members of the MIB_ANYCASTIPADDRESS_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_ANYCASTIPADDRESS_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 located on the local device and an IPv4 address was specified in the Address member of the MIB_ANYCASTIPADDRESS_ROW pointed to by the Row parameter. This error is also returned if no IPv6 stack is located on the local device and an IPv6 address was specified in the Address member. |
ERROR_OBJECT_ALREADY_EXISTS |
The object already exists. This error is returned if the Address member of the MIB_ANYCASTIPADDRESS_ROW pointed to by the Row parameter is a duplicate of an existing anycast IP address on the interface specified by the InterfaceLuid or InterfaceIndex member of the MIB_ANYCASTIPADDRESS_ROW. |
Other |
Use FormatMessage to obtain the message string for the returned error. |
Remarks
The CreateAnycastIpAddressEntry function is used to add a new anycast IP address entry on a local device.
The Address member in the MIB_ANYCASTIPADDRESS_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_ANYCASTIPADDRESS_ROW structure pointed to the Row parameter must be initialized to the interface: the InterfaceLuid or InterfaceIndex. The fields are used in the order listed here. If the InterfaceLuid is specified, this member is used to determine the interface on which to add the unicast IP address. 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.
The ScopeId member of the MIB_ANYCASTIPADDRESS_ROW structure pointed to by the Row is ignored when the CreateAnycastIpAddressEntry function is called. The ScopeId member is automatically determined by the interface on which the address is added.
The CreateAnycastIpAddressEntry function will fail if the anycast IP address passed in the Address member of the MIB_ANYCASTIPADDRESS_ROW pointed to by the Row parameter is a duplicate of an existing anycast IP address on the interface.
The CreateAnycastIpAddressEntry function can only be called by a user logged on as a member of the Administrators group. If CreateAnycastIpAddressEntry is called by a user who is not a member of the Administrators group, the function call will fail and ERROR_ACCESS_DENIED is returned.
See Also
Reference
IP Helper Functions
DeleteAnycastIpAddressEntry
GetAnycastIpAddressEntry
GetAnycastIpAddressTable
MIB_ANYCASTIPADDRESS_ROW
MIB_ANYCASTIPADDRESS_TABLE