Edit

Share via

DhcpGetSubnetInfoVQ function (dhcpsapi.h)

  • Article

The DhcpGetSubnetInfoVQ function retrieves the information about a specific IPv4 subnet defined on the DHCP server.

Syntax

DWORD DHCP_API_FUNCTION DhcpGetSubnetInfoVQ(
  [in]  DHCP_CONST WCHAR      *ServerIpAddress,
  [in]  DHCP_IP_ADDRESS       SubnetAddress,
  [out] LPDHCP_SUBNET_INFO_VQ *SubnetInfo
);

Parameters

[in] ServerIpAddress

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

[in] SubnetAddress

DHCP_IP_ADDRESS structure that contains the IPv4 address of the subnet for which the information will be modified.

[out] SubnetInfo

A DHCP_SUBNET_INFO_VQ structure that contains the returned information for the subnet matching the IPv4 address specified by SubnetAddress.

Note  

The memory for this parameter must be free using DhcpRpcFreeMemory.

 

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_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_NOT_PRESENT
 The specified subnet is not defined on the DHCP server.
ERROR_INVALID_PARAMETER
 One of the parameters provides an invalid value.

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