Difference between revisions of "OpenURL"

From Free Pascal wiki
Jump to navigationJump to search
m (→‎Definition: Fixed syntax highlighting)
(→‎Description: Fixed wiki markup; clarified text)
Line 9: Line 9:
  
 
==Description==
 
==Description==
'''openurl''' opens an URL with the default/registered web browser as specified by the operating system.
 
  
Apparently spaces need to be encoded (as %20); see [http://www.ietf.org/rfc/rfc1738.txt]
+
<syntaxhighlight lang=pascal inline>OpenUrl</syntaxhighlight> opens a URL with the default/registered/preferred web browser as specified by the operating system.
  
{{Warning|On Windows with Lazarus versions older than development version r40490 (2013-03-06), opening an URL using the file:// URI scheme (to open a local file) may fail if there are spaces in the filename.<br>
+
Spaces in URLs need to be encoded as %20; see [http://www.ietf.org/rfc/rfc1738.txt RFC1738]. When using the file:// URI scheme, you should not encode spaces with %20.
With those older Lazarus versions, you should enclose the entire string in double quotes, if you are on an NT platform.<br>
+
 
This is unfortunately system and browser dependant. Note: opening a file:// URL with spaces on Win9x will probably fail if you enclose the URL in quotes (See bug 21659 in the bugtracker).<br>
+
== Warning ==
On Windows it is preferable to not use OpenUrl with file:// URI scheme, but use [[opendocument|OpenDocument]] with the filename instead because of the above mentioned problems.<br>
+
 
When using the file:// URI scheme, you should not escape spaces with %20.}}
+
On Windows with Lazarus versions older than revision r40490 (2013-03-06), opening a URL using the file:// URI scheme (to open a local file) may fail if there are spaces in the filename.
 +
 
 +
With those older Lazarus versions, you should enclose the entire string in double quotation marks, if you are on an NT platform.
 +
 
 +
This is unfortunately system and browser dependant. Note: opening a file:// URL with spaces on Win9x will probably fail if you enclose the URL in quotation marks (See {{MantisLink|21659}}).
 +
 
 +
On Windows it is preferable to not use <syntaxhighlight lang=pascal inline>OpenUrl</syntaxhighlight> with the file:// URI scheme, but use [[opendocument|OpenDocument]] with the filename instead because of the above mentioned problems.
  
 
==Example==
 
==Example==

Revision as of 13:46, 29 March 2021

Definition

Unit: Lazarus lclintf

function OpenURL(AURL: String): Boolean;

Official documentation: [1]

Description

OpenUrl opens a URL with the default/registered/preferred web browser as specified by the operating system.

Spaces in URLs need to be encoded as %20; see RFC1738. When using the file:// URI scheme, you should not encode spaces with %20.

Warning

On Windows with Lazarus versions older than revision r40490 (2013-03-06), opening a URL using the file:// URI scheme (to open a local file) may fail if there are spaces in the filename.

With those older Lazarus versions, you should enclose the entire string in double quotation marks, if you are on an NT platform.

This is unfortunately system and browser dependant. Note: opening a file:// URL with spaces on Win9x will probably fail if you enclose the URL in quotation marks (See Issue #21659).

On Windows it is preferable to not use OpenUrl with the file:// URI scheme, but use OpenDocument with the filename instead because of the above mentioned problems.

Example

uses 
...
lclintf
...
OpenURL('http://wiki.lazarus.freepascal.org/');