Edit

Share via

DhcpV4FailoverGetAddressStatus function (dhcpsapi.h)

  • Article

The DhcpV4FailoverGetAddressStatus function returns the status of a IPv4 address.

Syntax

DWORD DHCP_API_FUNCTION DhcpV4FailoverGetAddressStatus(
  [in, optional] LPWSTR          ServerIpAddress,
  [in]           DHCP_IP_ADDRESS SubnetAddress,
  [in, out]      LPDWORD         pStatus
);

Parameters

[in, optional] ServerIpAddress

Pointer to a null-terminated Unicode string that represents the IP address or hostname of the DHCP server.

[in] SubnetAddress

DHCP_IP_ADDRESS structure that contains the IPv4 address whose status is being requested.

[in, out] pStatus

Pointer to a DWORD that returns the status of the IPv4 address as specified in the table below:

Value Meaning
0
 The IPv4 address will be leased by a primary server.
1
 The IPv4 address will be leased by a secondary server.
2
 The IPv4 address is part of an exclusion range.
3
 The IPv4 address is a reservation.

Return value

If the function succeeds, it returns ERROR_SUCCESS.

If the function fails, it returns one of the following or an error code from DHCP Server Management API Error Codes.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header dhcpsapi.h
Library Dhcpsapi.lib
DLL Dhcpsapi.dll