HTTP_READ_STATUS HTTPReadPostValue( BYTE* cData, WORD wLen );
Reads a value from a URL encoded string in the TCP buffer. This function is meant to be called from an HTTPExecutePost callback to facilitate easier parsing of incoming data. This function also prevents buffer overflows by forcing the programmer to indicate how many bytes are expected. At least 2 extra bytes are needed in cData above the maximum length of data expected to be read.
This function will read until the next '&' character, which indicates the end of a value parameter. It assumes that the front of the buffer is the beginning of the value paramter to be read. If curHTTP.byteCount indicates that all expected bytes are in the buffer, it assumes that all remaining data is the value and acts accordingly.
This function properly updates curHTTP.byteCount by decrementing it by the number of bytes read. The terminating '&' character is also removed from the buffer.
Front of TCP buffer is the beginning of a name parameter, and the rest of the TCP buffer contains a URL-encoded string with a name parameter terminated by a '=' character.
Parameters |
Description |
cData |
where to store the value once it is read |
wLen |
how many bytes can be written to cData |
Return Values |
Description |
HTTP_READ_OK |
value was successfully read |
HTTP_READ_TRUNCTATED |
entire value could not fit in the buffer, so the value was truncated and data has been lost |
HTTP_READ_INCOMPLETE |
entire value was not yet in the buffer, so call this function again later to retrieve |