DhcpEnumServers function (dhcpsapi.h)

The DhcpEnumServers function returns an enumerated list of DHCP servers found in the directory service.

Syntax

DWORD DhcpEnumServers(
  [in]  DWORD                    Flags,
  [in]  LPVOID                   IdInfo,
  [out] LPDHCP_SERVER_INFO_ARRAY *Servers,
  [in]  LPVOID                   CallbackFn,
  [in]  LPVOID                   CallbackData
);

Parameters

[in] Flags

Reserved for future use. This field should be set to 0.

[in] IdInfo

Pointer to an address containing the server's ID block. This field should be set to null.

[out] Servers

Pointer to a DHCP_SERVER_INFO_ARRAY structure that contains the output list of DHCP servers.

[in] CallbackFn

Pointer to the callback function that will be called when the server add operation completes. This field should be null.

[in] CallbackData

Pointer to a data block containing the formatted structure for callback information. This field should be null.

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 2000 Server [desktop apps only]
Target Platform	Windows
Header	dhcpsapi.h
Library	Dhcpsapi.lib
DLL	Dhcpsapi.dll

See also

DHCP_SERVER_INFO_ARRAY