diff options
Diffstat (limited to '')
-rw-r--r-- | offapi/com/sun/star/sdbc/DriverPropertyInfo.idl | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl b/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl new file mode 100644 index 000000000..6282fc4aa --- /dev/null +++ b/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl @@ -0,0 +1,80 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * 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 . + */ +#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 + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |