Url Tcl 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

set myUrl [new CkUrl]

Properties

DebugLogFilePath
string
# ckStr is a CkString
CkUrl_get_DebugLogFilePath $myUrl $ckStr
set strVal [CkUrl_get_debugLogFilePath $myUrl]
CkUrl_put_DebugLogFilePath $myUrl $strVal

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
top
Frag
string
# ckStr is a CkString
CkUrl_get_Frag $myUrl $ckStr
set strVal [CkUrl_get_frag $myUrl]
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".

top
Host
string
# ckStr is a CkString
CkUrl_get_Host $myUrl $ckStr
set strVal [CkUrl_get_host $myUrl]
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
top
HostType
string
# ckStr is a CkString
CkUrl_get_HostType $myUrl $ckStr
set strVal [CkUrl_get_hostType $myUrl]
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.

top
LastErrorHtml
string
# ckStr is a CkString
CkUrl_get_LastErrorHtml $myUrl $ckStr
set strVal [CkUrl_get_lastErrorHtml $myUrl]

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.

top
LastErrorText
string
# ckStr is a CkString
CkUrl_get_LastErrorText $myUrl $ckStr
set strVal [CkUrl_get_lastErrorText $myUrl]

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.

top
LastErrorXml
string
# ckStr is a CkString
CkUrl_get_LastErrorXml $myUrl $ckStr
set strVal [CkUrl_get_lastErrorXml $myUrl]

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.

top
LastMethodSuccess
boolean 1/0
set boolVal [CkUrl_get_LastMethodSuccess $myUrl]
CkUrl_put_LastMethodSuccess $myUrl $boolVal

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.

top
Login
string
# ckStr is a CkString
CkUrl_get_Login $myUrl $ckStr
set strVal [CkUrl_get_login $myUrl]
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".

top
Password
string
# ckStr is a CkString
CkUrl_get_Password $myUrl $ckStr
set strVal [CkUrl_get_password $myUrl]
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".

top
Path
string
# ckStr is a CkString
CkUrl_get_Path $myUrl $ckStr
set strVal [CkUrl_get_path $myUrl]
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
top
PathWithQueryParams
string
# ckStr is a CkString
CkUrl_get_PathWithQueryParams $myUrl $ckStr
set strVal [CkUrl_get_pathWithQueryParams $myUrl]
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".

top
Port
integer
set intVal [CkUrl_get_Port $myUrl]
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.

top
Query
string
# ckStr is a CkString
CkUrl_get_Query $myUrl $ckStr
set strVal [CkUrl_get_query $myUrl]
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".

top
Ssl
boolean 1/0
set boolVal [CkUrl_get_Ssl $myUrl]
Introduced in version 9.5.0.49

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

top
VerboseLogging
boolean 1/0
set boolVal [CkUrl_get_VerboseLogging $myUrl]
CkUrl_put_VerboseLogging $myUrl $boolVal

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.

top
Version
string
# ckStr is a CkString
CkUrl_get_Version $myUrl $ckStr
set strVal [CkUrl_get_version $myUrl]

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

More Information and Examples
top

Methods

ParseUrl
# url is a string
set status [CkUrl_ParseUrl $url]
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
top