Jump to main content

##

# TCPIP_STACK_Status Function

## C

    SYS_STATUS TCPIP_STACK_Status(
        SYS_MODULE_OBJ object
    );

## Description

This function provides the current status of the TCPIP stack moodule.

## Preconditions

The TCPIP_STACK_Initialize() function must have been called before calling this function.

## Parameters

Parameters | Description
--- | ---
object | Object handle, returned from TCPIP_STACK_Initialize().

## Returns

- SYS_STATUS_READY - Indicates that any previous initialization operation for the stack has completed.
- SYS_STATUS_BUSY - Indicates that a previous initialization operation for the stack has not yet completed.
- SYS_STATUS_ERROR - Indicates that the initialization operation has failed and the stack is in an error state.

## Remarks

After calling TCPIP_STACK_Initialize(), the stack will continue its initialization process in the TCPIP_STACK_Task() routine. This may take some time. The stack is ready to use only when the TCPIP_STACK_Status() returned SYS_STATUS_READY.