summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl
blob: c8f894c2c9e5c3624cfa5ca04bfd8e276fe0922b (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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/*************************************************************************
 *
 *  $RCSfile: DriverPropertyInfo.idl,v $
 *
 *  $Revision: 1.5 $
 *
 *  last change: $Author: mi $ $Date: 2002-10-03 13:06:54 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_sdbc_DriverPropertyInfo_idl__ 
#define __com_sun_star_sdbc_DriverPropertyInfo_idl__ 
 
 module com {  module sun {  module star {  module sdbc { 
 
 
// DocMerge from xml: struct com::sun::star::sdbc::DriverPropertyInfo
/** describes the driver properties for making a connection.
    
    
    <p>
    The DriverPropertyInfo is of interest only to advanced programmers
    who need to interact with a driver to discover and supply properties
    for connections.
    </p>
 */
struct DriverPropertyInfo
{
    // DocMerge from xml: field com::sun::star::sdbc::DriverPropertyInfo::Name
    /** is the name of the property.
     */
    string Name; 
 
     
    // DocMerge from xml: field com::sun::star::sdbc::DriverPropertyInfo::Description
    /** is a brief description of the property, which may be null.
     */
    string Description; 
 
     
    // DocMerge from xml: field com::sun::star::sdbc::DriverPropertyInfo::IsRequired
    /** is
        <TRUE/>
        if a value must be supplied for this property
        during 
        <code>Driver.connect</code>
        and
        <FALSE/>
        otherwise.
     */
    boolean IsRequired; 
 
     
    // DocMerge from xml: field com::sun::star::sdbc::DriverPropertyInfo::Value
    /** specifies the current value of the property,
        based on the driver-supplied default values.  This field
        may be empty if no value is known.
     */
    string Value; 
 
     
    // DocMerge from idl: field com::sun::star::sdbc::DriverPropertyInfo::Choices
    /** contains a sequence of possible values if the value for the field 
            <code>DriverPropertyInfo.value</code>
            may be selected 
            from a particular set of values; otherwise empty.
     */
    sequence<string> Choices; 
}; 
 
//============================================================================= 
 
}; }; }; }; 
 
/*=========================================================================== 
    $Log: not supported by cvs2svn $
    Revision 1.4.20.1  2002/02/18 09:00:56  oj
    #97563# parameter,return value and exception description
    
    Revision 1.4  2000/12/14 12:53:39  mi
    <true></true> -> <TRUE/> and same with FALSE
    
    Revision 1.3  2000/11/08 12:43:35  mi
    moved from api
    
    Revision 1.1.1.1  2000/09/18 23:35:40  hjs
    initial import
    
    Revision 1.3  2000/09/11 11:52:42  mi
    documentation merged from XML
     
    Revision 1.1  1999/11/24 08:41:00  dg 
    new StarDataBaseConnectivity 
     
===========================================================================*/ 
#endif