EscapeAndSendValue function

The EscapeAndSendValue function will escape special HTTP-header characters and URL characters as %XX and send the converted string to the client.

Syntax

int __stdcall EscapeAndSendValue(
	__in	ProtocolSession *psess,
	__in	ClientSession *sess,
	__in	char *inputString,
	__in	int timeout,
	__in	int flags
);

Parameters

psess [in]

A pointer to a ProtocolSession structure. This is a session assigned to a protocol at the moment it's loaded into the memory.

sess [in]

A pointer to a ClientSession structure. This is a session assigned to a new connection. This connection has been created by a type PT_RECEIVER protocol.

inputString [in]

A pointer to a null-terminated string containing the string to be escaped.

timeout [in]

The time in miliseconds that the client is allowed to block the connection. Set this parameter to zero for no timeout.

flags [in]

This parameter can be zero or a combination of the following values.

Value	Meaning
REPLACE_SPACE_WITH_ADD_SIGN 0x1	The space will not be escaped as '%20', but it will be esacped as '+'.
SKIP_SPECIAL_CHARS 0x2	Instead of escaping the special characters it will ignore (by not sending) those characters.
DONT_REPLACE_PATH_CHARACTERS 0x4	The characters $&+,/:=@ will not be escaped.

Return value

This can be one of the following values:

Value	Meaning
CE_NOERR 0	No error.
CE_NO_BUFFER_AVAILABLE 1	There is not enough free space available in the internal buffer.
CE_CONNECTION_CLOSED 2	Cannot complete the request because the connection with the client has been closed.
CE_UNKNOWN_ERROR 3	An error occurred and since the RSF_RETURN_ON_ERROR flag is set the function returns.
CE_TIMEOUT 4	A timeout has occurred.

Remarks

This function escapes in the same way as the EscapeValue function does.

Requirements

Should be exported by	-
Minimum supported API	1.00
Header	tvsserver_base.h
Library(x86)	tvs_server_http_protocol_x86.lib
Library(x64)	tvs_server_http_protocol_x64.lib
DLL(x86)	tvs_server_http_protocol_x86.DLL
DLL(x64)	tvs_server_http_protocol_x64.DLL