offapi/com/sun/star/sdbc/FILEConnectionProperties.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 /** represents the properties for a FILE connection (session) with a specific
  23     database. These properties can be used when calling the method
  24     com::sun::star::sdbc::XDriver::connect() or
  25     com::sun::star::sdbc::XDriverManager::getConnectionWithInfo().
  26
  27     <p>
  28     The properties for a connection contain additional information about how to connect to a database and
  29     how to control the behavior of the resulting connection should be.
  30
  31     </p>
  32     @see com::sun::star::sdbc::XDriver
  33     @see com::sun::star::sdbc::XDriverManager
  34     @see com::sun::star::sdbc::ConnectionProperties
  35  */
  36 service FILEConnectionProperties
  37 {
  38     service com::sun::star::sdbc::ConnectionProperties;
  39
  40     /** specifies the encoding to use to translate the backend data
  41
  42         <p>See the <a href="http://www.iana.org/assignments/character-sets">IANA character set list</a>
  43         for a list of valid values.</p>
  44
  45         <p>For internal purposes (e.g., when using an encoding for which no IANA character set name
  46         exists), this may also be an UNSIGNED SHORT value representing one of the rtl_TextEncoding
  47         values in rtl/textenc.h.</p>
  48     */
  49     [optional, property] string CharSet;
  50 };
  51
  52
  53 }; }; }; };
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */