blob: b6a1d969fb08c3b0673356029a961344cc7a2597 (
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
82
83
84
85
86
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_ucb_FetchResult_idl__
#define __com_sun_star_ucb_FetchResult_idl__
//=============================================================================
module com { module sun { module star { module ucb {
//=============================================================================
/** contains data of several rows of a <type>ContentResultSet</type>.
<p>This struct is returned from <member>XFetchProvider::fetch</member>,
for example.
*/
published struct FetchResult
{
//-------------------------------------------------------------------------
/** contains the demanded data.
<p>One any contains the data of one whole row. Those methods which
use this struct have to specify, what the any has to contain.
*/
sequence< any > Rows;
//-------------------------------------------------------------------------
/** indicates the index of the first row contained in
<member>FetchResult::Rows</member> in the original result set. So if
<member>FetchResult::StartIndex</member> equals <code>3</code>, the
first element in the sequence <member>FetchResult::Rows</member>
contains the data of the index <code>3</code> in the original result set.
<p>The following rows are one after the other, but the direction
depends on the value of <member>FetchResult::Direction</member>
*/
long StartIndex;
//-------------------------------------------------------------------------
/** indicates the orientation in which the rows are fetched and set into
the sequence <member>FetchResult::Rows</member>.
<p>When <member>FetchResult::Orientation</member> equals <TRUE/>, the
rows in <member>FetchResult::Rows</member> are ordered in the same way
as in the original result set.
*/
boolean Orientation;
//-------------------------------------------------------------------------
/** indicates whether and which error has occurred, while fetching.
<p>The value may contain zero or more constants of the
<type>FetchError</type> constants group.
*/
short FetchError;
};
//=============================================================================
}; }; }; };
#endif
|
