summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sdbc/DataTruncation.idl
blob: 91363dd6e027b4d4abe2b2d7237d58210846bec8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/* -*- 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_DataTruncation_idl__
#define __com_sun_star_sdbc_DataTruncation_idl__

#include <com/sun/star/sdbc/SQLWarning.idl>

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


/** reports a DataTruncation warning, on reads, or is thrown as a DataTruncation exception,
    on writes, when a data value is unexpectedly truncated.

    <p>
    The SQL state for a
    <code>DataTruncation</code>
    is <code>01004</code>.
    </p>
 */
published exception DataTruncation: SQLWarning
{

    /** is the index of the parameter or column value.
     */
    long Index;


    /** is
        `TRUE`
        if a parameter value is truncated.
     */
    boolean IsParameter;


    /** is
        `TRUE`
        if a read was truncated.
     */
    boolean DuringRead;


    /** contains the number of bytes of data that should have been transferred.
        This number may be approximate if data conversions were being
        performed. The value may be
        <code>-1</code>
        if the size is unknown.
     */
    long DataSize;


    /** contains the number of bytes of data actually transferred.
        The value may be
        <code>-1</code>
        if the size is unknown.
     */
    long TransferSize;
};


}; }; }; };
/*===========================================================================
===========================================================================*/
#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */