DhcpSetServerBindingInfo function (dhcpsapi.h)

Article
02/22/2024

The DhcpSetServerBindingInfo function sets endpoint bindings for the DHCP server.

Syntax

DWORD DHCP_API_FUNCTION DhcpSetServerBindingInfo(
  [in] DHCP_CONST WCHAR          *ServerIpAddress,
  [in] ULONG                     Flags,
  [in] LPDHCP_BIND_ELEMENT_ARRAY BindElementInfo
);

Parameters

[in] ServerIpAddress

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

[in] Flags

Specifies a set of flags describing endpoint properties.

Value	Meaning
DHCP_ENDPOINT_FLAG_CANT_MODIFY 0x01	The endpoints cannot be modified.

[in] BindElementInfo

DHCP_BIND_ELEMENT_ARRAY structure that contains the endpoint bindings for the DHCP server.

Return value

This function returns ERROR_SUCCESS upon a successful call. Otherwise, it returns one of the DHCP Server Management API Error Codes.

Remarks

This function requires network byte ordering for all DHCP_IP_ADDRESS values in parameter structures.

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