<html> <head> <title>Service FileHandler</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="navimainnone">Use</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"><a href="#ConstructorsSummary" class="navisub">Constructors' Summary</a></td> <td class="navisub"><a href="#ConstructorsDetails" class="navisub">Constructors' 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">logging</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">service FileHandler</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Supported Interface</b></dt> <dd><a href="XLogHandler.html">XLogHandler</a></dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>specifies a component implementing a log handler whose output channel is a file. </dd> <dd><p>The handler will use the <code>Encoding</code> attribute of <a href="XLogHandler.html">XLogHandler</a> to determine how to encode strings before actually writing them to the output file.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 2.3</dd> <dt><b>See also</b></dt> <dd><a href="XLogHandler.html">XLogHandler</a>::<a href="XLogHandler.html#Encoding">Encoding</a></dd> </dl> </td> </tr> </table> <hr> <hr> <a name="ConstructorsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Constructors' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#create">create</a></td> <td class="imsum_right">creates a log handler whose output is directed to a file given by URL. </td> </tr> <tr> <td class="imsum_left"><a href="#createWithSettings">createWithSettings</a></td> <td class="imsum_right">creates an instance of the log handler, using generic settings </td> </tr> </table> <a name="ConstructorsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Constructors' Details</td> </tr> <tr> <td class="imdetail"><a name="create" class="membertitle">create</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"/></tr> <tr> <td valign="top"><b>create</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> FileURL );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates a log handler whose output is directed to a file given by URL. </dd> <dt><b>Parameter FileURL</b></dt> <dd>the URL of the file to be created. This URL is resolved using the ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/PathSubstitution.html">PathSubstitution</a> service. That is, it is allowed to include placeholders such as <code>$(userurl)</code>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createWithSettings" class="membertitle">createWithSettings</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"/></tr> <tr> <td valign="top"><b>createWithSettings</b>(</td> <td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/NamedValue.html">NamedValue</a> ></td> <td valign="bottom"> Settings )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates an instance of the log handler, using generic settings </dd> <dt><b>Parameter Settings</b></dt> <dd>contains the initial settings for the log handler <p>The following settings are recognized and supported: <ul><li><code>Encoding</code> - denotes the initial value of the <a href="XLogHandler.html">XLogHandler</a>::<a href="XLogHandler.html#Encoding">Encoding</a></li> <li><code>Formatter</code> - denotes the initial value of the <a href="XLogHandler.html">XLogHandler</a>::<a href="XLogHandler.html#Formatter">Formatter</a></li> <li><code>Level</code> - denotes the initial value of the <a href="XLogHandler.html">XLogHandler</a>::<a href="XLogHandler.html#Level">Level</a></li> </ul></p> <p>Additionally, a setting name <code>FileURL</code> is recognized. It must be of type string, and denotes the file URL to which the handler's output should be directed.</p> <p>At least the URL argument must be present in the settings.</p> </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException if <arg>Settings</args> contains settings whose value is of the wrong type. </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 © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>