Url ActiveX Reference Documentation

Url

Provides an object representation of a URL and easy access to the parts of the URL.

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatUrl

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.Url")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.Url")

(Delphi)
obj := TChilkatUrl.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.Url')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.Url")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Url', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.Url");

Properties

Frag As String (read-only)

Introduced in version 9.5.0.49

Contains any text following a fragment marker (#) in the URL, excluding the fragment marker. Given the URI http://www.contoso.com/index.htm#main, the fragment is "main".

Host As String (read-only)

Introduced in version 9.5.0.49

The DNS host name or IP address part of the URL. For example, if the URL is "http://www.contoso.com:8080/", the Host is "www.contoso.com". If the URL is "https://192.168.1.124/test.html", the Host is "192.168.1.124".

(Classic ASP) Parse a URL into its Component Parts

(Visual FoxPro) Parse a URL into its Component Parts

(PowerBuilder) Parse a URL into its Component Parts

(SQL Server) Parse a URL into its Component Parts

(Visual Basic 6.0) Parse a URL into its Component Parts

(VBScript) Parse a URL into its Component Parts

HostType As String (read-only)

Introduced in version 9.5.0.49

The type of the host name specified in the URL. Possible values are:

  • "dns": The host name is a domain name system (DNS) style host name.
  • "ipv4": The host name is an Internet Protocol (IP) version 4 host address.
  • "ipv6": The host name is an Internet Protocol (IP) version 6 host address.

LastMethodSuccess As Long

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

Login As String (read-only)

Introduced in version 9.5.0.49

If the URL contains a login and password, this is the login part. For example, if the URL is "http://user:password@www.contoso.com/index.htm ", then the login is "user".

Password As String (read-only)

Introduced in version 9.5.0.49

If the URL contains a login and password, this is the password part. For example, if the URL is "http://user:password@www.contoso.com/index.htm ", then the password is "password".

Path As String (read-only)

Introduced in version 9.5.0.49

The path (and params) part of the URL, excluding the query and fragment. If the URL is: "http://www.amazon.com/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1", then the path is "/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3".

(Classic ASP) Parse a URL into its Component Parts

(Visual FoxPro) Parse a URL into its Component Parts

(PowerBuilder) Parse a URL into its Component Parts

(SQL Server) Parse a URL into its Component Parts

(Visual Basic 6.0) Parse a URL into its Component Parts

(VBScript) Parse a URL into its Component Parts

PathWithQueryParams As String (read-only)

Introduced in version 9.5.0.58

The path (and params) part of the URL, including the query params, but excluding the fragment. If the URL is: "http://www.amazon.com/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1", then then this property returns "/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1".

Port As Long (read-only)

Introduced in version 9.5.0.49

The port number of the URL.

For example, if the URL is "http://www.contoso.com:8080/", the port number is 8080.
If the URL is "https://192.168.1.124/test.html", the port number is the default 80.
If the URL is "https://www.amazon.com/", the port number is the default SSL/TLS port 443.

Query As String (read-only)

Introduced in version 9.5.0.49

The query part of the URL, excluding the fragment. If the URL is: "http://www.amazon.com/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1#frag", then the query is "pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1".

Ssl As Long (read-only)

Introduced in version 9.5.0.49

1 if the URL indicates SSL/TLS, otherwise false. A URL beginning with "https://" indicates SSL/TLS.

Methods

ParseUrl(url As String) As Long

Introduced in version 9.5.0.49

Parses a full URL. After parsing, the various parts of the URL are available iin the properties.

Returns 1 for success, 0 for failure.

(Classic ASP) Parse a URL into its Component Parts

(Visual FoxPro) Parse a URL into its Component Parts

(PowerBuilder) Parse a URL into its Component Parts

(SQL Server) Parse a URL into its Component Parts

(Visual Basic 6.0) Parse a URL into its Component Parts

(VBScript) Parse a URL into its Component Parts