www.beck-ipc.com

@CHIP-RTOS C Library V2.06 - TCP/IP API


Get_DHCP_Status_Ext

Get DHCP status of the Ethernet interface.

void Get_DHCP_Status_Ext ( unsigned int *dhcp_use,
                           unsigned int *dhcp_stat,
                           UserEthDhcp_Entry far * *dhcpptr );

Parameters

dhcp_use

Output parameter:  Pointer to a where a "DHCP in use" boolean value will be output to.  The location will be set to '1' if the DHCP is currently being used and '0' if not in use.

dhcp_stat

Output parameter:  Pointer to a where a DHCP status word will be stored.   The status is encoded as follows:
    0: System is not configured (is in progress)
    1: System is configured by a DHCP Server
    2: System configure retry failed (or no retry started before)

dhcpptr

Output Parameter:  Pointer to a pointer that will be set by this API call, referencing a UserEthDhcp_Entry data structure within @CHIP-RTOS memory.   This structure will contain some DHCP configuration data (read-only!).   If no data is available the pointer will be set to NULL.

Return Value

-- none --

Comments

The UserEthDhcp_Entry data is a read-only information.   Do not write to this data structure!

See Also

RTOS API

This library function invokes a RTOS software interrupt. Refer to this RTOS API function's documentation for more details.

Supported since or modified in @CHIP-RTOS version

    SC12SC13SC11SC1x3
    V1.00V1.00V1.00V0.90

This API List
List of C Libraries
@CHIP-RTOS Main Index


End of document