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