HTTPc_WebSockMsgClr()

Clears the HTTPc WebSocket Message Object passed as argument.

Files

http-c.h/http-c.c

Prototype

          void  HTTPc_WebSockMsgClr (HTTPc_WEBSOCK_MSG_OBJ  *p_msg_obj, 
                                     HTTPc_ERR              *p_err)

Arguments

p_msg_obj

Pointer to the HTTPc WebSocket Message Object to clear.

p_err

Pointer to variable that will receive the return error code from this function:

HTTPc_ERR_NONE
HTTPc_ERR_NULL_PTR
HTTPc_ERR_INIT_NOT_COMPLETED

Returned Values

None.

Required Configuration

None.

Notes / Warnings

• This function MUST be called after the µC/HTTP-client Suite Initialization has been completed.
• This function MUST be called before the HTTPc_WEBSOCK_MSG_OBJ object is used for the first time.