xref: /trunk/main/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_sdbc_DriverPropertyInfo_idl__
24cdf0e10cSrcweir#define __com_sun_star_sdbc_DriverPropertyInfo_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir module com {  module sun {  module star {  module sdbc {
27cdf0e10cSrcweir
28cdf0e10cSrcweir
29cdf0e10cSrcweir/** describes the driver properties for making a connection.
30cdf0e10cSrcweir
31cdf0e10cSrcweir
32cdf0e10cSrcweir    <p>
33cdf0e10cSrcweir    The DriverPropertyInfo is of interest only to advanced programmers
34cdf0e10cSrcweir    who need to interact with a driver to discover and supply properties
35cdf0e10cSrcweir    for connections.
36cdf0e10cSrcweir    </p>
37cdf0e10cSrcweir */
38cdf0e10cSrcweirpublished struct DriverPropertyInfo
39cdf0e10cSrcweir{
40cdf0e10cSrcweir    /** is the name of the property.
41cdf0e10cSrcweir     */
42cdf0e10cSrcweir    string Name;
43cdf0e10cSrcweir
44cdf0e10cSrcweir
45cdf0e10cSrcweir    /** is a brief description of the property, which may be null.
46cdf0e10cSrcweir     */
47cdf0e10cSrcweir    string Description;
48cdf0e10cSrcweir
49cdf0e10cSrcweir
50cdf0e10cSrcweir    /** is
51cdf0e10cSrcweir        <TRUE/>
52cdf0e10cSrcweir        if a value must be supplied for this property
53cdf0e10cSrcweir        during
54cdf0e10cSrcweir        <code>Driver.connect</code>
55cdf0e10cSrcweir        and
56cdf0e10cSrcweir        <FALSE/>
57cdf0e10cSrcweir        otherwise.
58cdf0e10cSrcweir     */
59cdf0e10cSrcweir    boolean IsRequired;
60cdf0e10cSrcweir
61cdf0e10cSrcweir
62cdf0e10cSrcweir    /** specifies the current value of the property,
63cdf0e10cSrcweir        based on the driver-supplied default values.  This field
64cdf0e10cSrcweir        may be empty if no value is known.
65cdf0e10cSrcweir     */
66cdf0e10cSrcweir    string Value;
67cdf0e10cSrcweir
68cdf0e10cSrcweir
69cdf0e10cSrcweir    /** contains a sequence of possible values if the value for the field
70cdf0e10cSrcweir            <code>DriverPropertyInfo.value</code>
71cdf0e10cSrcweir            may be selected
72cdf0e10cSrcweir            from a particular set of values; otherwise empty.
73cdf0e10cSrcweir     */
74cdf0e10cSrcweir    sequence<string> Choices;
75cdf0e10cSrcweir};
76cdf0e10cSrcweir
77cdf0e10cSrcweir//=============================================================================
78cdf0e10cSrcweir
79cdf0e10cSrcweir}; }; }; };
80cdf0e10cSrcweir
81cdf0e10cSrcweir/*===========================================================================
82cdf0e10cSrcweir===========================================================================*/
83cdf0e10cSrcweir#endif
84