2.2.1.2.18 DHCP_SEARCH_INFO

  • Article

The DHCP_SEARCH_INFO structure defines the DHCPv4 client information search type defined by SearchType, along with the data used within that search. This structure, used in the R_DhcpGetClientInfo (section 3.1.4.19) method, is used to search a specific DHCPv4 client.

 typedef struct _DHCP_SEARCH_INFO {
     DHCP_SEARCH_INFO_TYPE SearchType;
     [switch_is(SearchType), switch_type(DHCP_SEARCH_INFO_TYPE)]
     union _DHCP_CLIENT_SEARCH_UNION {
         [case(DhcpClientIpAddress)]  DHCP_IP_ADDRESS  ClientIpAddress;
         [case(DhcpClientHardwareAddress)]  DHCP_CLIENT_UID  ClientHardwareAddress;
         [case(DhcpClientName)]  LPWSTR  ClientName;
     } SearchInfo;
 } DHCP_SEARCH_INFO, *LPDHCP_SEARCH_INFO;

SearchType: This is an enumeration of type DHCP_SEARCH_INFO_TYPE (section 2.2.1.1.3) that contains the data type based on which the search is performed for a specific DHCPv4 client record held by the DHCPv4 server.

Value

Meaning

DhcpClientIpAddress

0

The DHCPv4 client IPv4 address (section 2.2.1.2.1), specified in a subsequent field, is used to search for the DHCPv4 client lease record in the DHCPv4 server database.

DhcpClientHardwareAddress

1

The DHCPv4 client unique ID (section 2.2.1.2.5.2), specified in a subsequent field, is used to search for the DHCPv4 client lease record in the DHCPv4 server database.

DhcpClientName

2

A pointer to a null-terminated Unicode string that contains the name of the DHCPv4 client. It is used to search for the DHCPv4 client lease record in the DHCPv4 server database.

SearchInfo: A union that can contain one of the following values chosen based on the value of SearchType.

ClientIpAddress: A pointer to a DHCP_IP_ADDRESS (section 2.2.1.2.1) structure that is used to search for the DHCPv4 client lease record in the DHCPv4 server database.

ClientHardwareAddress: A pointer to a DHCP_CLIENT_UID (section 2.2.1.2.5) structure that represents the unique ID of a DHCPv4 client (section 2.2.1.2.5.2). It is used to search for the DHCPv4 client lease record in the DHCPv4 server database.

ClientName: A pointer to a null-terminated Unicode string, of type LPWSTR, that contains the name of the DHCPv4 client. It is used to search for the DHCPv4 client lease record in the DHCPv4 server database. There is no restriction on the length of this Unicode string.