Edit

Share via

DhcpCreateSubnetVQ function (dhcpsapi.h)

  • Article

The DhcpCreateSubnetVQ function creates a new IPv4 subnet and its associated NAP state information on the DHCP server.

Syntax

DWORD DHCP_API_FUNCTION DhcpCreateSubnetVQ(
  [in] DHCP_CONST WCHAR               *ServerIpAddress,
  [in] DHCP_IP_ADDRESS                SubnetAddress,
  [in] DHCP_CONST DHCP_SUBNET_INFO_VQ *SubnetInfo
);

Parameters

[in] ServerIpAddress

Unicode string that specifies the IP address or hostname of the DHCP server.

[in] SubnetAddress

A DHCP_IP_ADDRESS value that contains the IPv4 address of the subnet's gateway.

[in] SubnetInfo

Pointer to a DHCP_SUBNET_INFO_VQ structure that contains specific settings for the subnet, including the subnet mask and IPv4 address of the subnet gateway.

Return value

This function returns ERROR_SUCCESS upon a successful call. Otherwise, it returns one of the DHCP Server Management API Error Codes. Commonly returned error codes include:

Return code Description
ERROR_ACCESS_DENIED
 This call was performed by a client who is not a member of the "DHCP Administrators" security group.
ERROR_DHCP_JET_ERROR
 An error occurred while accessing the DHCP server's database.
ERROR_DHCP_SUBNET_EXISTS
 The IPv4 scope parameters specified in the SubnetInfo parameter are incorrect. Either the IPv4 scope already exists, or its subnet address and mask are inconsistent with the subnet address and mask of an existing scope.

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

DHCP_SUBNET_INFO_VQ