Url Tcl Reference Documentation
Url
Current Version: 11.5.0
Chilkat.Url
Call
Read the hostname and determine whether it is a DNS name, IPv4 address,
or IPv6 address.
Access the URL path, query string, and combined path-with-query value for
request construction or routing.
Extract embedded userinfo credentials when a URL contains a login and
password component.
Determine the explicit or implied port and whether the URL represents an
SSL/TLS connection.
Read the URL fragment separately from the path and query for workflows
that need anchor or client-side state information.
For an extended overview, see
Url Class Overview.
Parse a URL into its host, path, query, credentials, port, fragment, and TLS details.
Chilkat.Url is a focused URL parsing class. Given a full URL, it
extracts the hostname, host type, login, password, path, query string,
fragment, port, and SSL/TLS status into easy-to-read properties. It is useful
when application code needs to inspect, validate, route, log, or pass URL
parts to lower-level networking or API code.
Parse full URLs
ParseUrl to break a complete URL into structured
properties that can be inspected individually.
Host and host type
Path and query
Login and password
Port and TLS status
Fragment handling
Url when the application needs to decompose a URL before
making a request or applying custom logic. Parse the full URL, read the
properties needed by the caller, then pass the relevant pieces to classes
such as Chilkat.Http, Chilkat.Rest, or
Chilkat.Socket. Use Url for parsing; use the
higher-level networking classes to actually send the request.
Object Creation
# 'this' is not a keyword in Tcl. It can freely be used as a variable name. set this [new CkUrl]
Properties
DebugLogFilePath
# ckStr is a CkString
CkUrl_get_DebugLogFilePath $this $ckStr
set strVal [CkUrl_get_debugLogFilePath $this]
CkUrl_put_DebugLogFilePath $this $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.
Frag
# ckStr is a CkString
CkUrl_get_Frag $this $ckStr
set strVal [CkUrl_get_frag $this]
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
# ckStr is a CkString
CkUrl_get_Host $this $ckStr
set strVal [CkUrl_get_host $this]
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.
HostType
# ckStr is a CkString
CkUrl_get_HostType $this $ckStr
set strVal [CkUrl_get_hostType $this]
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.
LastErrorHtml
# ckStr is a CkString
CkUrl_get_LastErrorHtml $this $ckStr
set strVal [CkUrl_get_lastErrorHtml $this]
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.
topLastErrorText
# ckStr is a CkString
CkUrl_get_LastErrorText $this $ckStr
set strVal [CkUrl_get_lastErrorText $this]
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.
LastErrorXml
# ckStr is a CkString
CkUrl_get_LastErrorXml $this $ckStr
set strVal [CkUrl_get_lastErrorXml $this]
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.
topLastMethodSuccess
set boolVal [CkUrl_get_LastMethodSuccess $this]
CkUrl_put_LastMethodSuccess $this $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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
Login
# ckStr is a CkString
CkUrl_get_Login $this $ckStr
set strVal [CkUrl_get_login $this]
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
# ckStr is a CkString
CkUrl_get_Password $this $ckStr
set strVal [CkUrl_get_password $this]
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
# ckStr is a CkString
CkUrl_get_Path $this $ckStr
set strVal [CkUrl_get_path $this]
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.
PathWithQueryParams
# ckStr is a CkString
CkUrl_get_PathWithQueryParams $this $ckStr
set strVal [CkUrl_get_pathWithQueryParams $this]
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
set intVal [CkUrl_get_Port $this]
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
# ckStr is a CkString
CkUrl_get_Query $this $ckStr
set strVal [CkUrl_get_query $this]
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
set boolVal [CkUrl_get_Ssl $this]
1 if the URL indicates SSL/TLS, otherwise false. A URL beginning with https:// indicates SSL/TLS.
Utf8
set boolVal [CkUrl_get_Utf8 $this]
CkUrl_put_Utf8 $this $boolVal
When set to 1, all string arguments and return values are interpreted as UTF-8 strings. When set to 0, they are interpreted as ANSI strings.
In Chilkat v11.0.0 and later, the default value is 1. Before v11.0.0, it was 0.
VerboseLogging
set boolVal [CkUrl_get_VerboseLogging $this]
CkUrl_put_VerboseLogging $this $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.
Version
# ckStr is a CkString
CkUrl_get_Version $this $ckStr
set strVal [CkUrl_get_version $this]
Methods
ParseUrl
set status [CkUrl_ParseUrl $this $url]
Parses a full URL. After parsing, the various parts of the URL are available iin the properties.
Returns 1 for success, 0 for failure.