<html> <head> <title>Struct URL</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="URL-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Command_URL" class="navimain">Devguide</a></td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#Elements" class="navisub">Elements' Summary</a></td> <td class="navisub"><a href="#ElementDetails" class="navisub">Elements' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">util</a> :: </p> </td> </tr> <tr> <td class="title">struct URL</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>represents the structure of an Uniform Resource Locator. </dd> <dd><p> If the structure represents a valid URL or not depends on prior usage of the functions of <a href="XURLTransformer.html">XURLTransformer</a>. Only after one of the functions returned <b>true</b> this can be assumed.</br> It is not necessary to set all of the fields; either <a href="URL.html#Complete">Complete</a> or (some of) the others are set. Additionally, most of the other fields, like <a href="URL.html#Host">Host</a>, <a href="URL.html#Port">Port</a>, <a href="URL.html#User">User</a>, <a href="URL.html#Password">Password</a>, or <a href="URL.html#Mark">Mark</a>, are optional. </dd> <dt><b>See also</b></dt> <dd><a href="XURLTransformer.html">XURLTransformer</a><br> </p> </dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Command_URL">OfficeDev - Command URL</a></dd> </dl> </td> </tr> </table> <hr> <a name="Elements"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Elements' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#Complete">Complete</a></td> <td class="imsum_right">contains the string representation of the complete URL, for example, http://www.sun.de:8080/pub/test/foo.txt?a=b#xyz </td> </tr> <tr> <td class="imsum_left"><a href="#Main">Main</a></td> <td class="imsum_right">contains the URL without a mark and without arguments, for example, http://www.sun.de:8080/pub/test/foo.txt </td> </tr> <tr> <td class="imsum_left"><a href="#Protocol">Protocol</a></td> <td class="imsum_right">contains the protocol (scheme) of the URL, for example, "http" </td> </tr> <tr> <td class="imsum_left"><a href="#User">User</a></td> <td class="imsum_right">contains the user-identifier of the URL, for example, "me" </td> </tr> <tr> <td class="imsum_left"><a href="#Password">Password</a></td> <td class="imsum_right">contains the users password of the URL, for example, "pass" </td> </tr> <tr> <td class="imsum_left"><a href="#Server">Server</a></td> <td class="imsum_right">contains the server part of the URL, for example, "www.sun.de" </td> </tr> <tr> <td class="imsum_left"><a href="#Port">Port</a></td> <td class="imsum_right">contains the port at the server of the URL, for example, "8080" </td> </tr> <tr> <td class="imsum_left"><a href="#Path">Path</a></td> <td class="imsum_right">contains all segments but the last one of the hierarchical path of the URL, for example, "/pub/test/" </td> </tr> <tr> <td class="imsum_left"><a href="#Name">Name</a></td> <td class="imsum_right">contains the last segment of the hierarchical path of the URL, for the above example, "foo.txt" </td> </tr> <tr> <td class="imsum_left"><a href="#Arguments">Arguments</a></td> <td class="imsum_right">contains the arguments part of the URL, for example, "a=b" </td> </tr> <tr> <td class="imsum_left"><a href="#Mark">Mark</a></td> <td class="imsum_right">contains the mark part of the URL, for example, "xyz" </td> </tr> </table> <a name="ElementDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Elements' Details</td> </tr> <tr> <td class="imdetail"><a name="Complete" class="membertitle">Complete</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Complete</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the string representation of the complete URL, for example, http://www.sun.de:8080/pub/test/foo.txt?a=b#xyz </dd> <dd><p> It is used as a central input/output or input parameter for the interfaces of <a href="XURLTransformer.html">XURLTransformer</a>. The usage of one of the <a href="XURLTransformer.html">XURLTransformer</a> function is mandatory to validate the URL. It cannot be assumed that <a href="URL.html">URL</a>::<a href="URL.html#Complete">Complete</a> represents always a valid URL! </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Main" class="membertitle">Main</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Main</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the URL without a mark and without arguments, for example, http://www.sun.de:8080/pub/test/foo.txt </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Protocol" class="membertitle">Protocol</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Protocol</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the protocol (scheme) of the URL, for example, "http" </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="User" class="membertitle">User</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>User</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the user-identifier of the URL, for example, "me" </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Password" class="membertitle">Password</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Password</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the users password of the URL, for example, "pass" </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Server" class="membertitle">Server</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Server</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the server part of the URL, for example, "www.sun.de" </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Port" class="membertitle">Port</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>Port</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the port at the server of the URL, for example, "8080" </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Path" class="membertitle">Path</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Path</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains all segments but the last one of the hierarchical path of the URL, for example, "/pub/test/" </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Name" class="membertitle">Name</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Name</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the last segment of the hierarchical path of the URL, for the above example, "foo.txt" </dd> <dd><p> <strong>Attention:</strong>A service implementing the <a href="XURLTransformer.html">XURLTransformer</a> interface will normally not detect if the last segment is a folder or a file. So it is possible that the last segment describes a folder. If you want to be sure that a file URL that references a folder will be correctly put into the URL fields you should append a "/" at the end of the hierarchical path. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Arguments" class="membertitle">Arguments</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Arguments</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the arguments part of the URL, for example, "a=b" </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Mark" class="membertitle">Mark</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Mark</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the mark part of the URL, for example, "xyz" </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
