xref: /aoo41x/main/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl (revision d1766043)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_sdbc_DriverPropertyInfo_idl__
#define __com_sun_star_sdbc_DriverPropertyInfo_idl__

 module com {  module sun {  module star {  module sdbc {


/** 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>
 */
published struct DriverPropertyInfo
{
	/** is the name of the property.
	 */
	string Name;


	/** is a brief description of the property, which may be null.
	 */
	string Description;


	/** is
		<TRUE/>
		if a value must be supplied for this property
		during
		<code>Driver.connect</code>
		and
		<FALSE/>
		otherwise.
	 */
	boolean IsRequired;


	/** 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;


	/** 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;
};

//=============================================================================

}; }; }; };

/*===========================================================================
===========================================================================*/
#endif