DHCP Server Management API Type Definitions

The following datatypes are used by the DHCP Server Management API.

typedef DWORD DHCP_IP_ADDRESS, *PDHCP_IP_ADDRESS, *LPDHCP_IP_ADDRESS;
typedef DWORD DHCP_OPTION_ID;
typedef DWORD DHCP_IP_MASK;
typedef DWORD DHCP_RESUME_HANDLE;
typedef ULONG DHCP_ATTRIB_ID, *PDHCP_ATTRIB_ID, *LPDHCP_ATTRIB_ID;
typedef DHCP_IPV6_ADDRESS DHCP_RESUME_IPV6_HANDLE;

DHCP_IP_ADDRESS

Specifies an IP address, with the first byte containing the first number in the address, the second byte containing the second number, the third byte containing the third number, and the last byte containing the last number in the address. For example, the address 192.1.1.10 is represented as 11000000 00000001 00000001 00001010 (binary), or 3221291274 (decimal).

DHCP_OPTION_ID

Specifies a unique DHCP option ID number (code). For example, the IETF documentation on DHCP options (also known as BOOTP vendor extensions), RFC 2132, defines the option code for a router IP address as 4.

DHCP_IP_MASK

Specifies an IP subnet mask. A subnet mask is represented in the same fashion as an IP address, with each sequential numeric component of the address placed in the corresponding byte field.

DHCP_RESUME_HANDLE

Specifies a unique handle to specific server data (such as options or classes) during an enumeration operation. This handle allows an enumeration to handle the data in chunks; for example, the initial call to an enumeration operation passes the handle as 0. Upon execution, a handle to the data is assigned, and this returned handle can be used for subsequent operations to resume the procurement of the remaining data.

DHCP_ATTRIB_ID

Specifies a value uniquely identifying a DHCP server attribute. An attribute describes some aspect of the DHCP server, such as whether or not it can serve BOOTP clients, or if it is part of a directory service domain controller.

DHCP_RESUME_IPV6_HANDLE

DHCP_IPV6_ADDRESS structure passed as a resume handle to enumeration operations on DHCPv6 servers.

Requirements

Minimum supported client
None supported
Minimum supported server
Windows 2000 Server [desktop apps only]
Header
Dhcpsapi.h