summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/io/XSeekable.idl
blob: 571b19ea3bb5e4a18843a87df78dd6d294ee2603 (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
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
/*************************************************************************
 *
 *  $RCSfile: XSeekable.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-08 09:44:34 $
 *
 *  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_io_XInputStream_idl__ 
#define __com_sun_star_io_XInputStream_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_io_IOException_idl__ 
#include <com/sun/star/io/IOException.idl> 
#endif 
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 
#include <com/sun/star/lang/IllegalArgumentException.idl> 
#endif 
 
//============================================================================= 
 
 module com {  module sun {  module star {  module io {  
 
//============================================================================= 
 
// DocMerge from xml: interface com::sun::star::io::XSeekable
/** This is the basic interface seek on a stream.<br>
    This interface should be supported if it is possible to access the
    data at the new position fast.<br>
    For example the access to a file should be fast enough.<br>
    You shouldn't support this interface for example if you have a
    continuous stream like a video stream.
 */
[ uik(A70C54B0-A297-11d3-ABD600A0-249D5590), ident( "XSeekable", 1.0 ) ]
interface XSeekable: com::sun::star::uno::XInterface
{ 
     
    // DocMerge from xml: method com::sun::star::io::XSeekable::seek
    /** Changes the seek pointer to a new location relative to the beginning of the stream.<br>
        This method changes the seek pointer so subsequent reads and writes can take place at a different 
        location in the stream object. It is an error to seek before the beginning of the stream. 
        However, it is not an error to seek past the end of the stream. Seeking past the end of the stream 
        is useful for subsequent writes, as the stream will at that time be extended to the seek position
        immediately before the write is done.
     */
    void seek( [in] hyper location )  
        raises( com::sun::star::lang::IllegalArgumentException, com::sun::star::io::IOException ); 
 
     
    // DocMerge from xml: method com::sun::star::io::XSeekable::getPosition
    /** Returns the current offset in this stream.
     */
    hyper getPosition() 
        raises( com::sun::star::io::IOException ); 
 
     
    // DocMerge from xml: method com::sun::star::io::XSeekable::getLength
    /** Returns the length of the storage medium on which the stream works.<br>
     */
    hyper getLength() 
        raises( com::sun::star::io::IOException ); 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
/*============================================================================= 
 
    $Log: not supported by cvs2svn $
    Revision 1.1.1.1  2000/09/18 23:35:24  hjs
    initial import
    
    Revision 1.3  2000/09/11 11:52:32  mi
    documentation merged from XML
     
    Revision 1.1  1999/11/25 07:57:41  mm 
    Seekable streams 
     
    Revision 1.1.1.1  1999/11/11 09:48:43  jsc 
    new 
     
 
=============================================================================*/ 
#endif