blob: 3327df30456b763c44f2fd06abd354988c13d558 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_logging_FileHandler_idl__
#define __com_sun_star_logging_FileHandler_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/beans/NamedValue.idl>
module com { module sun { module star { module logging {
interface XLogHandler;
/** specifies a component implementing a log handler whose output
channel is a file.
<p>The handler will use the <code>Encoding</code> attribute of XLogHandler
to determine how to encode strings before actually writing them to the output
file.</p>
@see XLogHandler::Encoding
@since OOo 2.3
*/
service FileHandler : XLogHandler
{
/** creates a log handler whose output is directed to a file given by URL.
@param 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 <code>$(userurl)</code>.
*/
create( [in] string FileURL );
/** creates an instance of the log handler, using generic settings
@param Settings
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 XLogHandler::Encoding</li>
<li><code>Formatter</code> - denotes the initial value of the XLogHandler::Formatter</li>
<li><code>Level</code> - denotes the initial value of the XLogHandler::Level</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>
@throws ::com::sun::star::lang::IllegalArgumentException
if `Settings` contains settings whose value is of the wrong type.
*/
createWithSettings( [in] sequence< ::com::sun::star::beans::NamedValue > Settings )
raises ( ::com::sun::star::lang::IllegalArgumentException );
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
