CkUrl Ruby Reference Documentation

CkUrl

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

Object Creation

obj = Chilkat::CkUrl.new()

Properties

# strVal is a string
# ckStr is a CkString
url.get_Frag(ckStr);
strVal = url.frag();

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

# strVal is a string
# ckStr is a CkString
url.get_Host(ckStr);
strVal = url.host();

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

Parse a URL into its Component Parts

# strVal is a string
# ckStr is a CkString
url.get_HostType(ckStr);
strVal = url.hostType();

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.

# strVal is a string
# ckStr is a CkString
url.get_Login(ckStr);
strVal = url.login();

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

# strVal is a string
# ckStr is a CkString
url.get_Password(ckStr);
strVal = url.password();

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

# strVal is a string
# ckStr is a CkString
url.get_Path(ckStr);
strVal = url.path();

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

Parse a URL into its Component Parts

# strVal is a string
# ckStr is a CkString
url.get_PathWithQueryParams(ckStr);
strVal = url.pathWithQueryParams();

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

# intVal is an integer
intVal = url.get_Port();

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.

# strVal is a string
# ckStr is a CkString
url.get_Query(ckStr);
strVal = url.query();

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

# boolVal is a boolean
boolVal = url.get_Ssl();

Introduced in version 9.5.0.49

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

# boolVal is a boolean
boolVal = url.get_Utf8();
url.put_Utf8(boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

Methods

# url is a string
status = url.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 true for success, false for failure.

Parse a URL into its Component Parts