Sign in Join
FPDoc Onlineexperiment

ResolveRelativeURI function

In unit URIParser

Return a relative link.

Declaration

pascal
function ResolveRelativeURI(const BaseUri: UnicodeString; 
 const RelUri: UnicodeString; 
 out ResultUri: UnicodeString): Boolean
 ; overload

Arguments

BaseUri

Base URI.

RelUri

URI relative to BaseURI or absolute URI.

ResultUri

Resulting absolute URI.

Function result

True if the operation was successful, False if not.

Description

ResolveRelativeURI returns in ResultUri an absolute link constructed from a base URI BaseURI and a relative link RelURI. One of the two URI names must have a protocol specified. If the RelURI argument contains a protocol, it is considered a complete (absolute) URI and is returned as the result.

The function returns True if a link was successfully returned.

Errors

If no protocols are specified, the function returns False

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.