Web Vuser Functions (WEB) > Alphabetical List of Web Vuser Functions > web_convert_param

web_convert_param

Converts HTML to a URL or plain text.

int web_convert_param( const char *ParamName, [char *SourceString] char *SourceEncoding, char *TargetEncoding, LAST );
Argument
Description
ParamName
The name of a parameter. The converted string will be saved in this parameter. If SourceString is not used, it initially contains the text to convert. Note that this is not a name–value pair. Pass only the name of the parameter.
SourceString
A literal string to convert. "SourceString=your text"
SourceEncoding
The encoding type of the source data: HTML, URL, or plain text, in the format:
"SourceEncoding=HTML"
"SourceEncoding=URL" or
"SourceEncoding=PLAIN"
TargetEncoding
The target data format: URL, HTML, or plain text, in the format:
"TargetEncoding=URL"
"TargetEncoding=HTML"
or
"TargetEncoding=PLAIN"
LAST
A marker indicating the end of the argument list.

Return Values

This function returns LR_PASS (0) on success, and LR_FAIL (1) on failure.

Parameterization

Standard Parameterization may be used for the Source and Target arguments.

General Information

The web_convert_param function either converts HTML text to plain text or URL, or converts plain text to URL.

If SourceString is not passed, the text in parameter ParamName is converted and the result overwrites the parameter value. If SourceString is passed, the source string is converted and stored in parameter ParamName.

SourceString can contain parameters. The source string is first evaluated, replacing parameters with their values, then converted. The result is stored in parameter ParamName.

HTML format uses codes for some non–alphanumerical characters, such as & for ampersand. URLs do not support non–alpha–numerical characters and use the escape sequence %number to represent them. To use an HTML value in a URL, you must therefore convert it into an escape sequence or plain text. For example, an ampersand is represented in a URL as %26. When you use this function to convert the HTML to plain text, it converts it to the way the character would appear in a browser.

The following table shows the same content in HTML, URL, and plain text formats:

HTML
URL
Plain Text
<mytag>&
%3Cmytag%3E%26
<mytag>&

This function is useful when you retrieve a URL from an HTML document, and you want to use it in an HTTP request such as web_custom_request.