Edit

DhcpGetSubnetInfo function (dhcpsapi.h)

  • Article

The DhcpGetSubnetInfo function returns information on a specific subnet.

Syntax

DWORD DHCP_API_FUNCTION DhcpGetSubnetInfo(
  [in]  DHCP_CONST WCHAR   *ServerIpAddress,
  [in]  DHCP_IP_ADDRESS    SubnetAddress,
  [out] LPDHCP_SUBNET_INFO *SubnetInfo
);

Parameters

[in] ServerIpAddress

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

[in] SubnetAddress

DHCP_IP_ADDRESS value that specifies the subnet ID.

[out] SubnetInfo

DHCP_SUBNET_INFO structure that contains the returned information for the subnet matching the ID specified by SubnetAddress.

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 uses host byte ordering for all DHCP_IP_ADDRESS values in the DHCP_SUBNET_INFO structure passed back to the caller in the SubnetInfo parameter. However, this function uses network byte order for the IpAddress member of the DHCP_HOST_INFO structure within the DHCP_SUBNET_INFO structure.

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_SUBNET_INFO