Edit

DhcpServerGetConfigVQ function (dhcpsapi.h)

  • Article

The DhcpServerGetConfigVQ function retrieves the current DHCP server configuration settings.

Syntax

DWORD DHCP_API_FUNCTION DhcpServerGetConfigVQ(
  [in]  DHCP_CONST WCHAR             *ServerIpAddress,
  [out] LPDHCP_SERVER_CONFIG_INFO_VQ *ConfigInfo
);

Parameters

[in] ServerIpAddress

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

[out] ConfigInfo

Pointer to the address of a DHCP_SERVER_CONFIG_INFO_VQ structure that contains the returned DHCP server configuration settings.

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.

Remarks

The caller of this function must free the memory pointed to by ConfigInfo by calling DhcpRpcFreeMemory.

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_SERVER_CONFIG_INFO_VQ

DhcpServerSetConfigVQ