TCPIP_HTTP_NET_ConnectionUserDataGet Function

C

const void* TCPIP_HTTP_NET_ConnectionUserDataGet(
    TCPIP_HTTP_NET_CONN_HANDLE connHandle
);

Description

This function returns the user data value for the current HTTP connection. This data belongs to the user and is not used in any way by the HTTP server module. It can be set by the user with TCPIP_HTTP_NET_ConnectionUserDataSet().

Preconditions

None.

Parameters

ParametersDescription
connHandleHTTP connection handle.

Returns

  • User data that's stored as part of the connection.

Remarks

None.

Example

uint32_t myConnData;

myConnData = (uint32_t)TCPIP_HTTP_NET_ConnectionUserDataGet(connHandle);