offapi/com/sun/star/sdbc/DataTruncation.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 #ifndef __com_sun_star_sdbc_DataTruncation_idl__
  20 #define __com_sun_star_sdbc_DataTruncation_idl__
  21
  22 #include <com/sun/star/sdbc/SQLWarning.idl>
  23
  24  module com {  module sun {  module star {  module sdbc {
  25
  26
  27 /** reports a DataTruncation warning, on reads, or is thrown as a DataTruncation exception,
  28     on writes, when a data value is unexpectedly truncated.
  29
  30     <p>
  31     The SQL state for a
  32     <code>DataTruncation</code>
  33     is <code>01004</code>.
  34     </p>
  35  */
  36 published exception DataTruncation: SQLWarning
  37 {
  38
  39     /** is the index of the parameter or column value.
  40      */
  41     long Index;
  42
  43
  44     /** is
  45         `TRUE`
  46         if a parameter value is truncated.
  47      */
  48     boolean IsParameter;
  49
  50
  51     /** is
  52         `TRUE`
  53         if a read was truncated.
  54      */
  55     boolean DuringRead;
  56
  57
  58     /** contains the number of bytes of data that should have been transferred.
  59         This number may be approximate if data conversions were being
  60         performed. The value may be
  61         <code>-1</code>
  62         if the size is unknown.
  63      */
  64     long DataSize;
  65
  66
  67     /** contains the number of bytes of data actually transferred.
  68         The value may be
  69         <code>-1</code>
  70         if the size is unknown.
  71      */
  72     long TransferSize;
  73 };
  74
  75
  76 }; }; }; };
  77 /*===========================================================================
  78 ===========================================================================*/
  79 #endif
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */