Url Delphi DLL Reference Documentation
Url
Current Version: 10.0.0
Provides an object representation of a URL and easy access to the parts of the URL.
Create/Dispose
var myObject: HCkUrl; begin myObject := CkUrl_Create(); // ... CkUrl_Dispose(myObject); end;
Creates an instance of the HCkUrl object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkUrl_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.
Properties
Frag
function CkUrl__frag(objHandle: HCkUrl): PWideChar; stdcall;
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".
See the notes about PWideChar memory ownership and validity.
topHost
function CkUrl__host(objHandle: HCkUrl): PWideChar; stdcall;
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".
See the notes about PWideChar memory ownership and validity.
HostType
function CkUrl__hostType(objHandle: HCkUrl): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topLastMethodSuccess
procedure CkUrl_putLastMethodSuccess(objHandle: HCkUrl; newPropVal: wordbool); stdcall;
Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False 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 = True and failure = False.
- 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 True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.
topLogin
function CkUrl__login(objHandle: HCkUrl): PWideChar; stdcall;
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".
See the notes about PWideChar memory ownership and validity.
topPassword
function CkUrl__password(objHandle: HCkUrl): PWideChar; stdcall;
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".
See the notes about PWideChar memory ownership and validity.
topPath
function CkUrl__path(objHandle: HCkUrl): PWideChar; stdcall;
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".
See the notes about PWideChar memory ownership and validity.
PathWithQueryParams
function CkUrl__pathWithQueryParams(objHandle: HCkUrl): PWideChar; stdcall;
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".
See the notes about PWideChar memory ownership and validity.
topPort
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
function CkUrl__query(objHandle: HCkUrl): PWideChar; stdcall;
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".
See the notes about PWideChar memory ownership and validity.
topSsl
True if the URL indicates SSL/TLS, otherwise false. A URL beginning with "https://" indicates SSL/TLS.
topMethods
ParseUrl
url: PWideChar): wordbool; stdcall;
Parses a full URL. After parsing, the various parts of the URL are available iin the properties.
Returns True for success, False for failure.