DhcpServerGetConfig function (dhcpsapi.h)

The DhcpServerGetConfig function returns the specific configuration settings of a DHCP server. Configuration information includes information on the JET database used to store subnet and client lease information, and the supported protocols.

Syntax

DWORD DHCP_API_FUNCTION DhcpServerGetConfig(
  [in]  DHCP_CONST WCHAR          *ServerIpAddress,
  [out] LPDHCP_SERVER_CONFIG_INFO *ConfigInfo
);

Parameters

[in] ServerIpAddress

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

[out] ConfigInfo

Pointer to a DHCP_SERVER_CONFIG_INFO structure that contains the specific configuration information for the DHCP server.

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.

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

DhcpServerGetConfigV4

DhcpServerSetConfig