<doc>
  <legacy_id>2474</legacy_id>
  <name>unload</name>
  <type>command</type>
  <syntax>
    <example>unload [URL] <i>cachedURL</i></example>
  </syntax>
  <library>Internet library</library>
  <objects>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Networks &amp; Communication</category>
  </classification>
  <references>
    <command tag="get">get Command</command>
    <command tag="libURLDownloadToFile">libURLDownloadToFile Command</command>
    <command tag="revUnloadSpeech">revUnloadSpeech Command</command>
    <command tag="libURLftpUpload">libURLftpUpload Command</command>
    <function tag="cachedURLs">cachedURLs Function</function>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
  </classes>
  <security>
    <network/>
  </security>
  <summary>Removes a <keyword tag="file">file</keyword> that was placed in the local <glossary tag="cache">cache</glossary> by the <command tag="load">load</command> <glossary tag="command">command</glossary>, or cancels a <glossary tag="download">download</glossary> or <glossary tag="upload">upload</glossary> in progress.</summary>
  <examples>
    <example>unload URL "http://www.example.com"</example>
    <example>unload URL (line 1 of the cachedURLs)</example>
    <example>unload URL "ftp://ftp.example.org/newfiles/latest.txt"</example>
  </examples>
  <description>
    <p>Use the <b>unload</b> <glossary tag="command">command</glossary> to release memory used by a <glossary tag="cache">cached</glossary> <keyword tag="URL">URL</keyword> when you no longer need it.</p><p/><p><b>Parameters:</b></p><p>The <i>cachedURL</i> is any <keyword tag="URL">URL</keyword> in the <function tag="cachedURLs">cachedURLs</function> or any <keyword tag="URL">URL</keyword> whose transfer was started with the <command tag="libURLftpUpload">libURLftpUpload</command>, <command tag="libURLftpUploadFile">libURLftpUploadFile</command>, or <command tag="libURLDownloadToFile">libURLDownloadToFile</command> <glossary tag="command">command</glossary>.</p><p/><p><b>Comments:</b></p><p>If the <i>cachedURL</i> is not in the <glossary tag="cache">cache</glossary> and not currently being <glossary tag="upload">uploaded</glossary> or <glossary tag="download">downloaded</glossary>, the <function tag="result">result</function> <control_st tag="function">function</control_st> is set to "can't find url".</p><p/><p>If the <i>cachedURL</i> is still being <glossary tag="download">downloaded</glossary> with the <command tag="load">load</command> <glossary tag="command">command</glossary>, the <b>unload</b> command cancels the <glossary tag="download">download</glossary>.</p><p/><p>The <b>unload</b> <glossary tag="command">command</glossary> can be used to cancel any <href tag="../glossary/nondashblocking.xml">non-blocking</href> <keyword tag="ftp">FTP</keyword> or <keyword tag="http">HTTP</keyword> file transfer in progress, but it does not cancel file transfers that were initiated by using a <keyword tag="URL">URL</keyword> <glossary tag="container">container</glossary> in an <glossary tag="expression">expression</glossary> or by putting something into a <keyword tag="URL">URL</keyword>.</p><p/><p>The <b>unload</b> <glossary tag="command">command</glossary> removes the <i>cachedURL</i> from the <function tag="URLStatus">URLStatus</function> <control_st tag="function">function</control_st>. This includes <glossary tag="URL">URLs</glossary> that have been <glossary tag="upload">uploaded</glossary> with the <command tag="libURLftpUpload">libURLftpUpload</command> <glossary tag="command">command</glossary>, as well as those that have been <glossary tag="cache">cached</glossary> with the <command tag="load">load</command> <glossary tag="command">command</glossary>.</p><p/><p><b>Note:</b> You can use a <keyword tag="URL">URL</keyword> with the <keyword tag="URL">URL</keyword> <glossary tag="keyword">keyword</glossary> even after it has been unloaded from the <glossary tag="cache">cache</glossary>, but <glossary tag="cache">caching</glossary> speeds up access to the <keyword tag="URL">URL</keyword>.</p>
  </description>
</doc>