LibreOffice
LibreOffice 24.2 SDK API Reference
DriverPropertyInfo.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20  module com { module sun { module star { module sdbc {
21 
22 
32 published struct DriverPropertyInfo
33 {
36  string Name;
37 
38 
41  string Description;
42 
43 
53  boolean IsRequired;
54 
55 
60  string Value;
61 
62 
68  sequence<string> Choices;
69 };
70 
71 
72 }; }; }; };
73 
74 /*===========================================================================
75 ===========================================================================*/
76 
77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
string Description
is a brief description of the property, which may be null.
Definition: DriverPropertyInfo.idl:41
Definition: Ambiguous.idl:20
boolean IsRequired
is TRUE if a value must be supplied for this property during Driver.connect and FALSE otherwise...
Definition: DriverPropertyInfo.idl:53
describes the driver properties for making a connection.
Definition: DriverPropertyInfo.idl:32
string Name
is the name of the property.
Definition: DriverPropertyInfo.idl:36
string Value
specifies the current value of the property, based on the driver-supplied default values...
Definition: DriverPropertyInfo.idl:60
sequence< string > Choices
contains a sequence of possible values if the value for the field DriverPropertyInfo.value may be selected from a particular set of values; otherwise empty.
Definition: DriverPropertyInfo.idl:68