offapi/com/sun/star/sdbc/DriverPropertyInfo.idl

   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
  23 /** describes the driver properties for making a connection.
  24
  25
  26     <p>
  27     The DriverPropertyInfo is of interest only to advanced programmers
  28     who need to interact with a driver to discover and supply properties
  29     for connections.
  30     </p>
  31  */
  32 published struct DriverPropertyInfo
  33 {
  34     /** is the name of the property.
  35      */
  36     string Name;
  37
  38
  39     /** is a brief description of the property, which may be null.
  40      */
  41     string Description;
  42
  43
  44     /** is
  45         `TRUE`
  46         if a value must be supplied for this property
  47         during
  48         <code>Driver.connect</code>
  49         and
  50         `FALSE`
  51         otherwise.
  52      */
  53     boolean IsRequired;
  54
  55
  56     /** specifies the current value of the property,
  57         based on the driver-supplied default values.  This field
  58         may be empty if no value is known.
  59      */
  60     string Value;
  61
  62
  63     /** contains a sequence of possible values if the value for the field
  64             <code>DriverPropertyInfo.value</code>
  65             may be selected
  66             from a particular set of values; otherwise empty.
  67      */
  68     sequence<string> Choices;
  69 };
  70
  71
  72 }; }; }; };
  73
  74 /*===========================================================================
  75 ===========================================================================*/
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */