DHCP_CLIENT_INFO_PB structure (dhcpsapi.h)

The DHCP_CLIENT_INFO_PB structure defines information about a DHCPv4 client, including filter status information and any policies that resulted in the IPv4 address assignment.

Syntax

typedef struct _DHCP_CLIENT_INFO_PB {
  DHCP_IP_ADDRESS  ClientIpAddress;
  DHCP_IP_MASK     SubnetMask;
  DHCP_CLIENT_UID  ClientHardwareAddress;
  LPWSTR           ClientName;
  LPWSTR           ClientComment;
  DATE_TIME        ClientLeaseExpires;
  DHCP_HOST_INFO   OwnerHost;
  BYTE             bClientType;
  BYTE             AddressState;
  QuarantineStatus Status;
  DATE_TIME        ProbationEnds;
  BOOL             QuarantineCapable;
  DWORD            FilterStatus;
  LPWSTR           PolicyName;
} DHCP_CLIENT_INFO_PB, *LPDHCP_CLIENT_INFO_PB;

Members

ClientIpAddress

DHCP_IP_ADDRESS structure that contains the DHCPv4 client IPv4 address.

SubnetMask

DHCP IP_MASK structure that contains the DHCPv4 client IPv4 subnet mask.

ClientHardwareAddress

DHCP_CLIENT_UID structure that contains the hardware address (MAC address) of the DHCPv4 client.

ClientName

Pointer to a null-terminated Unicode string that represents the DHCPv4 client machine name.

ClientComment

Pointer to a null-terminated Unicode string that represents the description of the DHCPv4 client.

ClientLeaseExpires

DATE_TIME structure that contains the lease expiry time for the DHCPv4 client. This is UTC time represented in the FILETIME format.

OwnerHost

DHCP_HOST_INFO structure that contains information about the host machine (DHCPv4 server machine) that provided a lease to the DHCPv4 client.

bClientType

Value that specifies the DHCPv4 client type. The possible values are below:

AddressState

Value that specifies various states of the IPv4 address. The possible values are below:

Status

QuarantineStatus enumeration that specifies possible health status values for the DHCPv4 client, as validated at the NAP server.

ProbationEnds

DATE_TIME structure that contains the probation end time if the DHCPv4 client is on probation. The DHCPv4 client has full access to the network for this time period. This is UTC time represented in the FILETIME format.

QuarantineCapable

TRUE, if the DHCPv4 client is quarantine-enabled; Otherwise, it is FALSE.

FilterStatus

Integer flag value that specifies the status of the link-layer filter.

PolicyName

Pointer to a null-terminated Unicode string that represents the DHCP server policy name that resulted in the IPv4 address assignment to the DHCPv4 client in the lease.

Requirements

See also

DHCP_CLIENT_INFO_PB_ARRAY

DhcpV4CreateClientInfo

DhcpV4GetClientInfo