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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
/*************************************************************************
*
* $RCSfile: XBlob.idl,v $
*
* $Revision: 1.1 $
*
* last change: $Author: mi $ $Date: 2000-11-06 09:21:57 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_sdbc_XBlob_idl__
#define __com_sun_star_sdbc_XBlob_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
module com { module sun { module star { module io {
interface XInputStream;
};};};};
#ifndef __com_sun_star_sdbc_SQLException_idl__
#include <com/sun/star/sdbc/SQLException.idl>
#endif
module com { module sun { module star { module sdbc {
// DocMerge from xml: interface com::sun::star::io::com::sun::star::sdbc::XBlob
/** is the representation (mapping) of an SQL <i>BLOB</i>.
<p>
A SQL <i>BLOB</i> is a built-in type that stores a
Binary Large Object as a column value in a row of a database table.
The driver implements <i>BLOB</i> using a
SQL <code>locator(BLOB)</code>, which means that a <code>Blob</code>
object contains a logical pointer to the SQL <i>BLOB</i> data rather
than the data itself.
<br>
A <code>Blob</code> object is valid for the duration of the
transaction in which is was created.
</p>
<p>Methods in the interfaces <type scope="com::sun::star::sdbc">XResultSet</type>,
and <type scope="com::sun::star::sdbc">XPreparedStatement</type>, such as
<code>getBlob</code> and <code>setBlob</code> allow a programmer to
access the SQL <i>BLOB</i>.<br>
The <code>Blob</code> interface provides methods for getting the
length of a SQL <i>BLOB</i> (Binary Large Object) value,
for materializing a <i>BLOB</i> value on the client and for
determining the position of a pattern of bytes within a
<i>BLOB</i> value.</p>
*/
[ uik(D6B6023A-9067-11d3-9EE00010-5AD7A5C4), ident("XBlob", 1.0) ]
interface XBlob: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::length
/** returns the number of bytes in the <i>BLOB</i> value
designated by this <code>Blob</code> object.
*/
hyper length() raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from idl: method com::sun::star::io::com::sun::star::sdbc::XBlob::getBytes
/** returns as an array of bytes part or all of the <i>BLOB</i>
value that this <code>Blob</code> object designates. The byte
array contains up to <code>length</code> consecutive bytes
starting at position <code>pos</code>.
@param pos
is the ordinal position of the first byte in the
<i>BLOB</i> value to be extracted; the first byte is at
position 1.
@param length
is the number of consecutive bytes to be copied.
@returns
a byte array containing up to <code>length</code>
consecutive bytes from the <i>BLOB</i> value designated
by this <code>Blob</code> object, starting with the
byte at position <code>pos</code>.
@throws SQLException
if there is an error accessing the <i>BLOB</i>.
*/
sequence<byte> getBytes([in]hyper pos, [in]long length)
raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::getBinaryStream
/** retrieves the <i>BLOB</i> designated by this
<code>Blob</code> instance as a stream.
*/
com::sun::star::io::XInputStream getBinaryStream()
raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::position
/** determines the byte position at which the specified byte
<code>pattern</code> begins within the <i>BLOB</i>
value that this <code>Blob</code> object represents. The
search for <code>pattern</code> begins at position
<code>start</code>.
*/
hyper position([in]sequence<byte> pattern, [in]hyper start)
raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::positionOfBlob
/** determines the byte position in the <i>BLOB</i> value
designated by this <code>Blob</code> object at which
<code>pattern</code> begins. The search begins at position
<code>start</code>.
*/
hyper positionOfBlob([in]XBlob pattern,[in] hyper start)
raises (SQLException);
};
//=============================================================================
}; }; }; };
/*===========================================================================
$Log: not supported by cvs2svn $
Revision 1.1.1.1 2000/09/18 23:35:41 hjs
initial import
Revision 1.8 2000/09/11 11:52:42 mi
documentation merged from XML
Revision 1.6 2000/02/07 11:24:52 mi
zu #70728# missing documentation marked
Revision 1.5 2000/01/14 11:09:11 mi
XML syntax error in documentation
Revision 1.4 1999/12/20 16:11:35 dg
#70278# changes in API
Revision 1.3 1999/12/13 13:47:54 dg
#70278# XSQLErrorBroadcaster removed
Revision 1.2 1999/11/24 11:33:26 dg
chk includes
Revision 1.1 1999/11/24 08:41:04 dg
new StarDataBaseConnectivity
===========================================================================*/
#endif
|
