Url ActiveX Reference Documentation

Url

Current Version: 11.0.0

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

Object Creation

Note:
For versions of Chilkat < 10.0.0, use "Chilkat_9_5_0.Url" instead of "Chilkat.Url"
For a specific major version, use "Chilkat.Url.<major_version>", such as "Chilkat.Url.10" for Chilkat v10.*.*
See Chilkat ActiveX Object Creation

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

(AutoIt)
$obj = ObjCreate("Chilkat.Url")

(Visual Basic 6.0)
Dim obj As New ChilkatUrl

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

(VBA, such as Excel)
Dim obj As New ChilkatUrl
See How to Use ActiveX in Excel

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

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

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

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

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

Properties

DebugLogFilePath

DebugLogFilePath As String

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

(AutoIt) Example showing how to use DebugLogFilePath.(Classic ASP) Example showing how to use DebugLogFilePath.(PowerBuilder) Example showing how to use DebugLogFilePath.(SQL Server) Example showing how to use DebugLogFilePath.(VBScript) Example showing how to use DebugLogFilePath.(Visual Basic 6.0) Example showing how to use DebugLogFilePath.(Visual FoxPro) Example showing how to use DebugLogFilePath.

Frag

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

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".

More Information and Examples

(AutoIt) Parse a URL into its Component Parts (Classic ASP) Parse a URL into its Component Parts (PowerBuilder) Parse a URL into its Component Parts (SQL Server) Parse a URL into its Component Parts (VBScript) Parse a URL into its Component Parts (Visual Basic 6.0) Parse a URL into its Component Parts (Visual FoxPro) Parse a URL into its Component Parts

HostType

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.

LastBinaryResult

LastBinaryResult As Variant (read-only)

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

LastErrorHtml

LastErrorHtml As String (read-only)

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

LastErrorText As String (read-only)

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

LastErrorXml As String (read-only)

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

LastMethodSuccess As Long

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

LastStringResult

LastStringResult As String (read-only)

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

More Information and Examples

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen

LastStringResultLen As Long (read-only)

The length, in characters, of the string contained in the LastStringResult property.

Login

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

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

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".

More Information and Examples

(AutoIt) Parse a URL into its Component Parts (Classic ASP) Parse a URL into its Component Parts (PowerBuilder) Parse a URL into its Component Parts (SQL Server) Parse a URL into its Component Parts (VBScript) Parse a URL into its Component Parts (Visual Basic 6.0) Parse a URL into its Component Parts (Visual FoxPro) Parse a URL into its Component Parts

PathWithQueryParams

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

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

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

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.

VerboseLogging

VerboseLogging As Long

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

Version As String (read-only)

Version of the component/library, such as "10.1.0"

More Information and Examples

(AutoIt) How to get the Chilkat version at runtime.(Classic ASP) How to get the Chilkat version at runtime.(PowerBuilder) How to get the Chilkat version at runtime.(SQL Server) How to get the Chilkat version at runtime.(VBScript) How to get the Chilkat version at runtime.(Visual Basic 6.0) How to get the Chilkat version at runtime.(Visual FoxPro) How to get the Chilkat version at runtime.

Methods

ParseUrl

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.

More Information and Examples

(AutoIt) Parse a URL into its Component Parts (Classic ASP) Parse a URL into its Component Parts (PowerBuilder) Parse a URL into its Component Parts (SQL Server) Parse a URL into its Component Parts (VBScript) Parse a URL into its Component Parts (Visual Basic 6.0) Parse a URL into its Component Parts (Visual FoxPro) Parse a URL into its Component Parts