Url CkPython Reference Documentation
CkUrl
Current Version: 11.0.0
Provides an object representation of a URL and easy access to the parts of the URL.
Object Creation
obj = chilkat.CkUrl()
Properties
DebugLogFilePath
# ckStr is a CkString
url.get_DebugLogFilePath(ckStr);
strVal = url.debugLogFilePath();
url.put_DebugLogFilePath(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
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".
topHost
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
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
url.get_LastErrorHtml(ckStr);
strVal = url.lastErrorHtml();
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
url.get_LastErrorText(ckStr);
strVal = url.lastErrorText();
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
url.get_LastErrorXml(ckStr);
strVal = url.lastErrorXml();
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
boolVal = url.get_LastMethodSuccess();
url.put_LastMethodSuccess(boolVal);
Indicates the success or failure of the most recent method call: True
means success, False
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.
Login
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".
topPassword
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".
topPath
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
url.get_PathWithQueryParams(ckStr);
strVal = url.pathWithQueryParams();
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".
topPort
intVal = url.get_Port();
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
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".
topSsl
boolVal = url.get_Ssl();
True
if the URL indicates SSL/TLS, otherwise false. A URL beginning with "https://" indicates SSL/TLS.
VerboseLogging
boolVal = url.get_VerboseLogging();
url.put_VerboseLogging(boolVal);
If set to True
, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False
. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
Methods
ParseUrl
status = url.ParseUrl(url);
Parses a full URL. After parsing, the various parts of the URL are available iin the properties.
Returns True for success, False for failure.