tfHttpcUserRetrieveVariable

Jump to: navigation, search

Table of Contents >> Application Reference >> Web Client


#include <trsocket.h>


int tfHttpcUserRetrieveVariable (
ttHttpcUserConHandle conHandle,
ttUserGenericUnionPtr genParamPtr,
int flags
);



Function Description

Retrieve the user data previously stored on the HTTP client connection. Should be used together with tfHttpcUserStoreVariable() to remember the HTTP client sending and receiving progress in non-blocking mode. This API can be called at any time after the connection is open and before it is closed. If user hasn’t called tfHttpcUserStoreVariable() before, a generic union with internal value set to 0 will be retrieved.



Parameters

  • conHandle
    HTTP client user connection handle
  • genParamPtr
    User pointer to a generic union variable to store the retrieved variable in
  • flags
    Not used



Returns

  • TM_ENOERROR
    Success
  • TM_EINVAL
    Invalid client connection handle



Table of Contents >> Application Reference >> Web Client