Edit

DhcpAddSubnetElement function (dhcpsapi.h)

  • Article

The DhcpAddSubnetElement function adds an element describing a feature or aspect of the subnet to the subnet entry in the DHCP database.

Syntax

DWORD DHCP_API_FUNCTION DhcpAddSubnetElement(
  [in] DHCP_CONST WCHAR                    *ServerIpAddress,
  [in] DHCP_IP_ADDRESS                     SubnetAddress,
  [in] DHCP_CONST DHCP_SUBNET_ELEMENT_DATA *AddElementInfo
);

Parameters

[in] ServerIpAddress

Pointer to a Unicode string that contains the IPv4 address of the subnet DHCP server.

[in] SubnetAddress

DHCP_IP_ADDRESS structure that contains the IPv4 address of the subnet.

[in] AddElementInfo

Pointer to a DHCP_SUBNET_ELEMENT_DATA structure that contains information about the subnet element corresponding to the IPv4 subnet specified in SubnetAddress.

Return value

This function returns ERROR_SUCCESS upon a successful call. Otherwise, it returns one of the DHCP Server Management API Error Codes.

Return code Description
ERROR_DHCP_JET_ERROR
 An error occurred while accessing the DHCP server database.
ERROR_DHCP_SUBNET_NOT_PRESENT
 The specified IPv4 subnet does not exist.
ERROR_DHCP_INVALID_RANGE
 The specified IPv4 address range either overlaps an existing range or is not valid.
ERROR_DHCP_IPRANGE_CONV_ILLEGAL
 Conversion of a scope to a DHCPv4-only scope or to a BOOTP-only scope is not allowed when DHCPv4 and BOOTP clients are present in the scope to convert. Manually delete either the DHCPv4 or the BOOTP clients from the scope, as appropriate for the type of scope being created.
ERROR_DHCP_IPRANGE_EXISTS
 The specified IPv4 address range already exists.
ERROR_DHCP_MSCOPE_RANGE_TOO_SMALL
 The multicast scope range must allow for at least 256 IPv4 addresses.
ERROR_DHCP_NOT_RESERVED_CLIENT
 The specified DHCPv4 client is not an IPv4 reserverdclient.
ERROR_DHCP_RESERVEDIP_EXISTS
 The specified IPv4 address or hardware address is in use by another DHCPv4 client.
ERROR_DHCP_ADDRESS
 The specified address is not available.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header dhcpsapi.h
Library Dhcpsapi.lib
DLL Dhcpsapi.dll

See also

DhcpAddSubnetElementV4

DhcpAddSubnetElementV5