::InstallAPI::FetchURL

Fetch the given URL and store its contents into virtual text or in a file.

Supported Platforms

All

Returns

Empty string or error.

Options

-blocksize <size>

The block size to use when downloading.  The smaller the block size, the finer the progress bar will be, but it will usually be slower because more calls are made to download the full file size.

-file <filename>

The name of a file to store the downloaded file to.  This can also be a list of files separated by ; that corresponds to a list of URLs separated by ;.  Each URL relates to one file in the list.

-progressvirtualtext <virtual text>

The name of a virtual text variable (without <% and %>) to update as the progress of the download.  This is usually attached to a progress bar.

-proxyhost <hostname>

The host name of a proxy server to use for the request.

-proxyport <port number>

The port number of a proxy server to use for the request.

-statusvirtualtext <virtual text>

The name of a virtual text variable (without <% and %>) to update with status as the files are downloaded.  This will set the status virtual text to <%DownloadVirtualText%> as the files are downloaded.  If more than one file is specified, the status will also contain the current and total file count.

-url <URL>

A URL or a list of URLs separated by ; to download.

-virtualtext <virtual text>

A virtual text variable or list of virtual text variables separated by ; (without <% and %>) to store the downloaded files into.  Each URL relates to a single virtual text variable.