@URLEncode (Formula Language)

Syntax

@URLEncode( encodingFormat ; token )

Parameters

encodingFormat

Text. The type of encoding you want to use to translate the token. You can specify either a string argument or a MIME character set.

String arguments:

• "Domino®" -- Encodes the token in the standard character set used by the Domino Web server. This keyword is equivalent to the "UTF-8" MIME character set.
• "Platform" -- Encodes the token using the current system's native character set.

MIME character set:

Converts non-ASCII characters into the specified character set and encodes the characters into %XX format, where XX is a hexadecimal digit representing the encoded value. Some examples include:

• "UTF-8" -- UCS(Universal Character Set) Transformation Format 8.An ASCII-compatible multi-byte Unicode and UCS encoding.
• "ISO-8859-1" -- The ISO's (International Standards Organization) 8-bit, single-byte-coded graphic character set for European languages.
• "Shift_JIS" -- The character set for the Japanese language.

token

Text or text list. URL string(s) to be encoded.

Return value

encodedURLString

Text or text list. Returns the URL string(s) encoded in the specified encoding format.

Usage

Do not use @URLEncode to encode an entire URL string. For example, @URLEncode("Domino";"http://www.ibm.com/") returns "http%3A%2Fwww.ibm.com%2F," which would not link successfully to the desired website.

Examples

1. This formula returns "By%20Date" as the encoded URL.

   @URLEncode("Domino";"By Date")

2. This formula returns "Support%20%E0%20la%20client%E8le" as the encoded URL.

   @URLEncode("ISO-8859-1";"Support à la clientèle")

3. This formula returns "Support%20%C3A0%20la%20client%C3%A8le" as the encoded URL.

   @URLEncode("UTF-8";"Support à la clientèle")