<html> <head> <title>Service PathSubstitution</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="PathSubstitution-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</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">Services' Summary</td> <td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td> <td class="navisub">Properties' Summary</td> <td class="navisub">Services' Details</td> <td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></td> <td class="navisub">Properties' Details</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">service PathSubstitution</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>A service to support the substitution and resubstitution of path variables. </dd> <dd><p> A path variable must be specified with the following synatx: "$("<variable-name>")". Path variables are not case sensitive and are always provided as a UCB-complient URL's (for example: "file:///c:/temp" or "file:///usr/install"). This is mandatory to support an optional remote file system.<br> A user defined list of path variables is supported. This list is stored in the Office configuration file (org/openoffice/Office/Substitution.xml). Please have a look at the schema definition file which configuration structure this file uses.<br> There is also a set of variables that have pre-defined values: </p> <dl> <dt>$(inst)</dt> <dd>Installation path of the Office Basis layer.</dd> <dt>$(prog)</dt> <dd>Program path of the Office Basis layer.</dd> <dt>$(brandbaseurl)</dt> <dd>Installation path of the the Office Brand layer.</dd> <dt>$(user)</dt> <dd>The user installation directory.</dd> <dt>$(work)</dt> <dd>The work directory of the user. Under Windows this would be the "MyDocuments" subdirectory. Under Unix this would be the home-directory</dd> <dt>$(home)</dt> <dd>The home directory of the user. Under Unix this would be the home- directory. Under Windows this would be the "Documents and Settings\<username>" subdirectory.</dd> <dt>$(temp)</dt> <dd>The current temporary directory.</dd> <dt>$(path)</dt> <dd>The value of PATH environment variable.</dd> <dt>$(lang)</dt> <dd>The country code used by the Office, like 01=english, 49=german.</dd> <dt>$(langid)</dt> <dd>The language code used by the Office, like 0x0009=english, 0x0409=english us.</dd> <dt>$(vlang)</dt> <dd>The language used by the Office as a string. Like "german" for a german Office.</dd> </dl> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> </dl> </td> </tr> </table> <hr> <a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Summary</td> </tr> <tr> <td class="imsum_left"><a href="XStringSubstitution.html">XStringSubstitution</a></td> <td class="imsum_right"><p>Interface to exchange path variables with defined paths and to resubstitute paths with path variables. (<a href="#XStringSubstitution">details</a>)</p> </td> </tr> </table> <a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="XStringSubstitution" class="membertitle"><a href="XStringSubstitution.html">XStringSubstitution</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Interface to exchange path variables with defined paths and to resubstitute paths with path variables. </dd> <dd><p> To resubstitute path variables the caller must provide pathes as UCB-compliant URL's. </p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2009 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>