Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

unpublished service FileHandler
Supported Interface
XLogHandler
Usage Restrictions
not published
Description
specifies a component implementing a log handler whose output channel is a file.

The handler will use the Encoding attribute of XLogHandler to determine how to encode strings before actually writing them to the output file.

Since
OOo 2.3
See also
XLogHandler::Encoding


Constructors' Summary
create creates a log handler whose output is directed to a file given by URL.  
createWithSettings creates an instance of the log handler, using generic settings  
Constructors' Details
create
create( [in] string  FileURL );

Description
creates a log handler whose output is directed to a file given by URL.
Parameter FileURL
the URL of the file to be created. This URL is resolved using the ::com::sun::star::util::PathSubstitution service. That is, it is allowed to include placeholders such as $(userurl).
createWithSettings
createWithSettings( [in] sequence< ::com::sun::star::beans::NamedValue >  Settings )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
creates an instance of the log handler, using generic settings
Parameter Settings
contains the initial settings for the log handler

The following settings are recognized and supported:

Additionally, a setting name FileURL is recognized. It must be of type string, and denotes the file URL to which the handler's output should be directed.

At least the URL argument must be present in the settings.

Throws
::com::sun::star::lang::IllegalArgumentException if Settings contains settings whose value is of the wrong type.

 
Top of Page

Apache Software Foundation

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

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