URLEncode (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | Français

Functions for managing strings

URLEncode

Presentation

Example

Characters allowed in an encoded URL

Constants for managing character strings

Functions for managing character strings

HTMLToRTF

HTMLToText

Handling character strings

Managing the Unicode format in the character strings

MatchRegularExpression

NumToFinancialWritingChinese

Serialization constants

SystemIntegerToInteger

This content comes from an automatic translation.

Characters allowed in an encoded URL
Special cases

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

URLEncode (Function)

In french: URLEncode

Encodes a URL with a sub-set of ASCII characters. This function is used to replace the unauthorized characters in a URL (accented characters, spaces, ...). An encoded URL can be decoded by URLDecode.

Remark: The syntax of the URL is not checked.

Example

// Encodes a URL
EncodedURL = URLEncode("http://my site/my page")

// EncodedURL now contains http://my%20site/my%20page
// The two spaces are transformed into %20

Versions 22 and later

MyURL is UNICODE string = "http://my site/my page"
MyEncodedURL is string

// Encodes a URL
MyEncodedURL = URLEncode(MyURL, encodeURLFromUnicode)

New in version 22

MyURL is UNICODE string = "http://my site/my page"
MyEncodedURL is string

// Encodes a URL
MyEncodedURL = URLEncode(MyURL, encodeURLFromUnicode)

Versions 22 and later

// Encode a URL with a URL parameter
Info(URLEncode("https://www.google.fr/?", encodeURLFromAnsi) + ...
URLEncode(URLEncode("https://www.google.fr/?é", encodeURLFromAnsi), encodeURLParameter))

New in version 22

// Encode a URL with a URL parameter
Info(URLEncode("https://www.google.fr/?", encodeURLFromAnsi) + ...
URLEncode(URLEncode("https://www.google.fr/?é", encodeURLFromAnsi), encodeURLParameter))

Syntax

<Result> = URLEncode(<URL> [, <Encoding format>])

<Result>: Character string

Character string containing the encoded URL. The unauthorized characters are changed into %xx where xx is the hexadecimal value of this character.
This function returns no error code because all the character strings can be encoded.

<URL>: Character string (with quotes)

URL to encode (in ANSI format).

<Encoding format>: Optional Integer constant

Versions 22 and later
Format for encoding the URL:
encodeURLFromAnsi URL format. The encoded text only contains characters allowed in a URL. The text to encode is an ANSI string.
encodeURLFromUTF8
(Default value) URL format. The encoded text only contains characters allowed in a URL. The text to encode is a UTF-8 string.
encodeURLParameter URL format. The reserved characters of a URL are encoded in order to pass a URL in parameter to a URL.
Caution: You must have encoded the URL passed as a parameter with one of the constants encodeURLSinceAnsi or encodeURLSinceUTF8.

New in version 22
Format for encoding the URL:
encodeURLFromAnsi URL format. The encoded text only contains characters allowed in a URL. The text to encode is an ANSI string.
encodeURLFromUTF8
(Default value) URL format. The encoded text only contains characters allowed in a URL. The text to encode is a UTF-8 string.
encodeURLParameter URL format. The reserved characters of a URL are encoded in order to pass a URL in parameter to a URL.
Caution: You must have encoded the URL passed as a parameter with one of the constants encodeURLSinceAnsi or encodeURLSinceUTF8.

Format for encoding the URL:
encodeURLFromAnsi URL format. The encoded text only contains characters allowed in a URL. The text to encode is an ANSI string.
encodeURLFromUTF8
(Default value) URL format. The encoded text only contains characters allowed in a URL. The text to encode is a UTF-8 string.
encodeURLParameter URL format. The reserved characters of a URL are encoded in order to pass a URL in parameter to a URL.
Caution: You must have encoded the URL passed as a parameter with one of the constants encodeURLSinceAnsi or encodeURLSinceUTF8.

Remarks

Characters allowed in an encoded URL

The list of acceptable characters for an encoded URL is as follows:


;	/	?	:	@
&	=	+	$	,
-	_	.	!	~
*	'	(	\|	)
%	#	the digits	the letters (uppercase and lowercase characters)

According to the options, some of these characters can be encoded by the function.

Special cases

The encoding of an empty URL (empty string) is an empty URL.
Special case: the % sign and the + sign
- The % sign being used for the decimal encoding, this character is encoded in decimal as well.
- The "+" sign, which is an alternative to %20 for encoding a space, is also encoded (to avoid problems when decoding).

Component : wd250std.dll