<html> <head> <title>Interface XLogHandler</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="XLogHandler-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"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' 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">interface XLogHandler</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XLogHandler</strong> ┗ ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows life time control for the handler </dd> <dd><p>Disposing the handler effectively means closing the channel to which the handler forwards the log records. </dd> </dl> </td> </tr> </table> </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>provides possibilites to send <a href="LogRecord.html">LogRecord</a>s to an arbitrary output channel. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 2.3</dd> <dt><b>See also</b></dt> <dd><a href="XLogger.html">XLogger</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#flush">flush</a></td> <td class="imsum_right">flushes all buffered output of the handler </td> </tr> <tr> <td class="imsum_left"><a href="#publish">publish</a></td> <td class="imsum_right">publish the given log record at the handler's output channel. </td> </tr> </table> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#Encoding">Encoding</a></td> <td class="imsum_right">specifies MIME charset name for the encoding to be used by this handler </td> </tr> <tr> <td class="imsum_left"><a href="#Formatter">Formatter</a></td> <td class="imsum_right">specifies the formatter to be used by this handler. </td> </tr> <tr> <td class="imsum_left"><a href="#Level">Level</a></td> <td class="imsum_right">specifies the log level of this handler </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="flush" class="membertitle">flush</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">void</td> </tr> <tr> <td valign="top"><b>flush</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>flushes all buffered output of the handler </dd> <dd><p>Log handlers are allowed to buffer their output. Upon <code>flush</code> being called, they must flush all their buffers.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="publish" class="membertitle">publish</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">boolean</td> </tr> <tr> <td valign="top"><b>publish</b>(</td> <td valign="top">[in] <a href="LogRecord.html">LogRecord</a></td> <td valign="bottom"> Record );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>publish the given log record at the handler's output channel. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if and only if the record was actually published. A handler will not publish a record if its log level doesn't meet the handler's log level, if the record is filtered, or if any other handler-specified restrictions apply. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="Encoding" class="membertitle">Encoding</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Encoding</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies MIME charset name for the encoding to be used by this handler </dd> <dd><p>It depends on the concrete handler implementation whether or not this parameter is needed.<p> </dd> <dt><b>See also</b></dt> <dd><a href="http://www.iana.org/assignments/character-sets">http://www.iana.org/assignments/character-sets</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Formatter" class="membertitle">Formatter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="XLogFormatter.html">XLogFormatter</a> <b>Formatter</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the formatter to be used by this handler. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Level" class="membertitle">Level</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>Level</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the log level of this handler </dd> <dd><p>Different handlers can have different log levels, which again might be different from the log level of the <a href="XLogger.html">XLogger</a> for which the handlers are used.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <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>