TCPIP_HTTP_CurrentConnectionUserDataSet Function

C

void TCPIP_HTTP_CurrentConnectionUserDataSet(
    HTTP_CONN_HANDLE connHandle, 
    const void* uData
);

Description

This function will set 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 is available to the usesr by calling TCPIP_HTTP_CurrentConnectionUserDataGet.

Preconditions

None.

Parameters

ParametersDescription
connHandleHTTP connection handle.
uDataUser supplied data.

Returns

None.

Remarks

None.

Example

uint32_t myConnData;

TCPIP_HTTP_CurrentConnectionUserDataSet(connHandle, (const void*)myConnData);