summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sdbc/DataTruncation.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/sdbc/DataTruncation.idl')
-rw-r--r--offapi/com/sun/star/sdbc/DataTruncation.idl81
1 files changed, 81 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sdbc/DataTruncation.idl b/offapi/com/sun/star/sdbc/DataTruncation.idl
new file mode 100644
index 000000000..91363dd6e
--- /dev/null
+++ b/offapi/com/sun/star/sdbc/DataTruncation.idl
@@ -0,0 +1,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: */