Edit

Share via

DhcpGetServerBindingInfo function (dhcpsapi.h)

  • Article

The DhcpGetServerBindingInfo function returns endpoint bindings set on the DHCP server.

Syntax

DWORD DHCP_API_FUNCTION DhcpGetServerBindingInfo(
  [in]  DHCP_CONST WCHAR          *ServerIpAddress,
  [in]  ULONG                     Flags,
  [out] LPDHCP_BIND_ELEMENT_ARRAY *BindElementsInfo
);

Parameters

[in] ServerIpAddress

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

[in] Flags

Specifies a set of flags describing the endpoints to return.

Value Meaning
DHCP_ENDPOINT_FLAG_CANT_MODIFY
0x01
 Returns unmodifiable endpoints only.

[out] BindElementsInfo

Pointer to a DHCP_BIND_ELEMENT_ARRAY structure that contains the server network endpoint bindings.

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.

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

See also

DHCP_BIND_ELEMENT_ARRAY

DhcpSetServerBindingInfo