Meet us at at Real World in Orlando, Florida.

All functions   Mac OS X   Windows   Crossplatform   Components   Guides  
New in version: 2.0   2.1   2.2   2.3   2.4   2.5   2.6   2.7   2.8  

CURL.SetOptionURL

Component: CURL
Version: 2.5
Mac OS X: Works
Windows: Works

MBS( "CURL.SetOptionURL"; handle; URL )

Parameters

Parameter Description Example value
Handle The CURL session handle. $curl
URL The URL you want to use. "http://www.mbsplugins.de/"

Result

Returns "OK" on success.

Description

The actual URL to deal with.
The parameter should be a text string which must be URL-encoded in the following format:

scheme://host:port/path

For a greater explanation of the format please see RFC 3986 (http://curl.haxx.se/rfc/rfc3986.txt).

If the given URL lacks the scheme, or protocol, part ("http://" or "ftp://" etc), libcurl will attempt to resolve which protocol to use based on the given host mame. If the protocol is not supported, libcurl will return (CURLE_UNSUPPORTED_PROTOCOL) when you call CURL.Preform or CURL.PerformInBackground. Use CURL.Protocols for detailed information on which protocols are supported.

The host part of the URL contains the address of the server that you want to connect to. This can be the fully qualified domain name of the server, the local network name of the machine on your network or the IP address of the server or machine represented by either an IPv4 or IPv6 address. For example:

http://www.example.com/

http://hostname/

http://192.168.0.1/

http://[2001:1890:1112:1::20]/

It is also possible to specify the user name and password as part of the host, for some protocols, when connecting to servers that require authentication.

For example the following types of authentication support this:

http://user:password@www.domain.com ftp://user:password@ftp.domain.com pop3://user:password@mail.domain.com

The port is optional and when not specified libcurl will use the default port based on the determined or specified protocol: 80 for http, 21 for ftp and 25 for smtp, etc. The following examples show how to specify the port:

http://www.weirdserver.com:8080/ - This will connect to a web server using port 8080.

smtp://mail.domain.com:587/ - This will connect to a smtp server on the alternative mail port.

The path part of the URL is protocol specific and whilst some examples are given below this list is not conclusive:

HTTP

The path part of a HTTP request specifies the file to retrieve and from what directory. If the directory is not specified then the web server's root directory is used. If the file is omitted then the default document will be retrieved for either the directory specified or the root directory. The exact resource returned for each URL is entirely dependent on the server's configuration.

http://www.netscape.com - This gets the main page (index.html in this example) from Netscape's web server.

http://www.netscape.com/index.html - This returns the main page from Netscape by specifying the page to get.

http://www.netscape.com/contactus/ - This returns the default document from the contactus directory.

FTP

The path part of an FTP request specifies the file to retrieve and from what directory. If the file part is omitted then libcurl downloads the directory listing for the directory specified. If the directory is omitted then the directory listing for the root / home directory will be returned.

ftp://cool.haxx.se - This retrieves the directory listing for our FTP server.

ftp://cool.haxx.se/readme.txt - This downloads the file readme.txt from the root directory.

ftp://cool.haxx.se/libcurl/readme.txt - This downloads readme.txt from the libcurl directory.

ftp://user:password@my.example.com/readme.txt - This retrieves the readme.txt file from the user's home directory. When a username and password is specified, everything that is specified in the path part is relative to the user's home directory. To retrieve files from the root directory or a directory underneath the root directory then the absolute path must be specified by prepending an additional forward slash to the beginning of the path.

ftp://user:password@my.example.com//readme.txt - This retrieves the readme.txt from the root directory when logging in as a specified user.

SMTP

The path part of a SMTP request specifies the host name to present during communication with the mail server. If the path is omitted then libcurl will attempt to resolve the local computer's host name. However, this may not return the fully qualified domain name that is required by some mail servers and specifying this path allows you to set an alternative name, such as your machine's fully qualified domain name, which you might have obtained from an external function such as gethostname or getaddrinfo.

smtp://mail.domain.com - This connects to the mail server at domain.com and sends your local computer's host name in the HELO / EHLO command.

smtp://mail.domain.com/client.domain.com - This will send client.domain.com in the HELO / EHLO command to the mail server at domain.com.

POP3

The path part of a POP3 request specifies the mailbox (message) to retrieve. If the mailbox is not specified then a list of waiting messages is returned instead.

pop3://user:password@mail.domain.com - This lists the available messages pop3://user:password@mail.domain.com/1 - This retrieves the first message

SCP

The path part of an SCP request specifies the file to retrieve and from what directory. The file part may not be omitted. The file is taken as an absolute path from the root directory on the server. To specify a path relative to the user's home directory on the server, prepend ~/ to the path portion. If the user name is not embedded in the URL, it can be set with the CURL.SetOptionUsername option.

scp://user@example.com/etc/issue - This specifies the file /etc/issue

scp://example.com/~/my-file - This specifies the file my-file in the user's home directory on the server

SFTP

The path part of an SFTP request specifies the file to retrieve and from what directory. If the file part is omitted then libcurl downloads the directory listing for the directory specified. If the path ends in a / then a directory listing is returned instead of a file. If the path is omitted entirely then the directory listing for the root / home directory will be returned. If the user name is not embedded in the URL, it can be set with the SetOptionUsername option.

sftp://user:password@example.com/etc/issue - This specifies the file /etc/issue

sftp://user@example.com/~/my-file - This specifies the file my-file in the user's home directory

sftp://ssh.example.com/~/Documents/ - This requests a directory listing of the Documents directory under the user's home directory

NOTES

Starting with version 7.20.0, the fragment part of the URI will not be sent as part of the path, which was previously the case.

CURLOPT_URL is the only option that must be set before CURL.Preform or CURL.PerformInBackground is called.

CURLOPT_PROTOCOLS can be used to limit what protocols libcurl will use for this transfer, independent of what libcurl has been compiled to support. That may be useful if you accept the URL from an external source and want to limit the accessibility.

Examples

MBS( "CURL.SetOptionURL"; $curl; "ftp://user:password@my.example.com//readme.txt" )

Feedback: Report problem or ask question.



Links
MBS Real Studio Plugins - Jugendzentrum Nickenich