English:

The Free and Open Productivity Suite
New: Apache OpenOffice 4.1.1 released!

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: logging ::

interface XLogHandler
Base Interfaces
XLogHandler
┗ ::com::sun::star::lang::XComponent

::com::sun::star::lang::XComponent
Description
allows life time control for the handler

Disposing the handler effectively means closing the channel to which the handler forwards the log records.

Description
provides possibilites to send LogRecords to an arbitrary output channel.
Since
OOo 2.3
See also
XLogger

Methods' Summary
flush flushes all buffered output of the handler  
publish publish the given log record at the handler's output channel.  
Attributes' Summary
Encoding specifies MIME charset name for the encoding to be used by this handler  
Formatter specifies the formatter to be used by this handler.  
Level specifies the log level of this handler  
Methods' Details
flush
void
flush();

Description
flushes all buffered output of the handler

Log handlers are allowed to buffer their output. Upon flush being called, they must flush all their buffers.

publish
boolean
publish( [in] LogRecord  Record );

Description
publish the given log record at the handler's output channel.
Returns
true 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.
Attributes' Details
Encoding
string Encoding;
Description
specifies MIME charset name for the encoding to be used by this handler

It depends on the concrete handler implementation whether or not this parameter is needed.

See also
http://www.iana.org/assignments/character-sets
Formatter
XLogFormatter Formatter;
Description
specifies the formatter to be used by this handler.
Level
long Level;
Description
specifies the log level of this handler

Different handlers can have different log levels, which again might be different from the log level of the XLogger for which the handlers are used.

Top of Page

Apache Software Foundation

Apache Software Foundation

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.