Jump to main content

##

# TCPIP_DHCPS_LEASE_SET Structure

## C

    typedef struct
    {
        IPV4_ADDR       ipAddress;
        uint32_t        leaseTime;
        uint8_t         leaseState;
        uint8_t         clientIdLen;
        uint8_t         clientId[];
    }TCPIP_DHCPS_LEASE_SET;

## Description

Structure: TCPIP_DHCPS_LEASE_SET

DHCP Server module lease set data.

Structure used to set a DHCP server lease

## Remarks

If clientIdLen > than TCPIP_DHCPS_CLIENT_ID_MAX_SIZE characters then truncation will occur!

## Members

Members | Description
--- | ---
ipAddress | IP address to set
leaseTime | lease time
| use 0xffffffff for permanent lease
leaseState | The state of the lease.
| Normally should be TCPIP_DHCPS_LEASE_STATE_BOUND
| Only TCPIP_DHCPS_LEASE_STATE_BOUND, TCPIP_DHCPS_LEASE_STATE_RELEASED or TCPIP_DHCPS_LEASE_STATE_EXPIRED allowed
clientIdLen | the size of the clientId
clientId | the client ID used for this lease