2.2.1.2.21 DHCP_MCLIENT_INFO

The DHCP_MCLIENT_INFO structure defines information about the MADCAP client that is used by the method R_DhcpGetMClientInfo (section 3.2.4.12).

 typedef struct _DHCP_MCLIENT_INFO {
   DHCP_IP_ADDRESS ClientIpAddress;
   DWORD MScopeId;
   DHCP_CLIENT_UID ClientId;
   LPWSTR ClientName;
   DATE_TIME ClientLeaseStarts;
   DATE_TIME ClientLeaseEnds;
   DHCP_HOST_INFO OwnerHost;
   DWORD AddressFlags;
   BYTE AddressState;
 } DHCP_MCLIENT_INFO,
  *LPDHCP_MCLIENT_INFO;

ClientIpAddress: This is of type DHCP_IP_ADDRESS (section 2.2.1.2.1) that contains the MADCAP client's IPv4 address.

MScopeId: This is of type DWORD that specifies the unique identifier of the multicast scope from which the MADCAP client receives an IPv4 multicast address.

ClientId: This is of type DHCP_CLIENT_UID (section 2.2.1.2.5) that represents a MADCAP lease identifier (section 2.2.1.2.5.4).

ClientName: A pointer to a null-terminated Unicode string that represents the MADCAP client's internet host name. There is no restriction on the length of this Unicode string.

ClientLeaseStarts: This is of type DATE_TIME (section 2.2.1.2.11) that contains the lease start date and time for the MADCAP client. This is UTC time.

ClientLeaseEnds: This is of type DATE_TIME that contains the lease expiry time for the MADCAP client. This is UTC time.

OwnerHost: This is of type DHCP_HOST_INFO (section 2.2.1.2.7) that contains information about the MADCAP server machine that has provided a lease to the MADCAP client.

AddressFlags: This is of type DWORD. This MUST be set to zero when sent and ignored on receipt. It MUST be specified as zero in the RPC method that modifies the MADCAP server configuration. It MUST be treated as an error if the value is nonzero in the RPC method that queries the MADCAP server configuration.

AddressState: This is of type BYTE that represents the state of the IPv4 address given to the MADCAP client. The following table represents the different values and their meanings.

Value

Meaning

ADDRESS_STATE_OFFERED

0x00000000

The MADCAP client has been offered this IPv4 address.

ADDRESS_STATE_ACTIVE

0x00000001

The IPv4 address is active and has an active MADCAP client lease record.

ADDRESS_STATE_DECLINED

0x00000002

The IPv4 address request was declined by the MADCAP client; hence it is a bad IPv4 address.

ADDRESS_STATE_DOOM

0x00000003

The IPv4 address is in DOOMED state and is due to be deleted.