Jump to main content

##

# TCPIP_TCP_SocketTraceSet Function

## C

    bool TCPIP_TCP_SocketTraceSet(
        TCP_SOCKET sktNo,
        bool enable
    );

## Description

This function enables or disables the trace status of the specified socket. The trace functionality needs to be enabled in the TCP module for this function to succeed. Currently when socket trace is enabled, the current socket state transitions are displayed at the system console.

## Preconditions

TCP properly initialized.

## Parameters

Parameters | Description
--- | ---
sktNo | Socket to enable/disable trace.
enable | Boolean to enable/disable socket trace.

## Returns

- True - If the operation succeeded.
- False - If there was an error (no such socket, tracing not enabled, etc.).

## Remarks

None.