UrlEncode(aText As String) As String

 

Encodes the components of a URL.

 

A valid URL is a series of components that are separated by component separators.

They are the ".", "/", ";", "&", and "?".

 

If we use url functions then we must pass in an encoded url as a parameter,

otherwise these functions might fail. Another function

 

Functions which require to UrlEncode parameters: PdfWebLink, ShowURL

 

Parameters:

 

Name

Type

Description

aText

String

A string to be url encoded.

 

Returns:

 

Type

Value

Description

String

an url encoded string

Returns the url encoded version of the passed in string aText.

 

Available in:

 

WindowMain

WindowLink

YES

YES

 

Used in:

 

XojoScript Name

GUID

Create Seminar Invoice As PDF

2C3F7F29-A29A-4338-ACF5-51894B709DA5

Create Seminar Invoice With Slip As PDF

739DA58E-17EE-41CE-BB54-E7362CFE17D4

 

Hint: You can find references to XojoScripts which make use of this function by sending the following SQL statement to the database:

Select id,GUID, ScriptName,ScriptCode from im_scripts where ScriptCode Like '%UrlEncode%'

 

Example XojoScript:

 

Dim s As String

s = UrlEncode("www.Bob&Ray.com")

MsgBox(s)  // shows www.Bob%26Ray.com