LibreOffice
LibreOffice 26.2 SDK API Reference
Toggle main menu visibility
Loading...
Searching...
No Matches
XInputStream.idl
Go to the documentation of this file.
1
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2
/*
3
* This file is part of the LibreOffice project.
4
*
5
* This Source Code Form is subject to the terms of the Mozilla Public
6
* License, v. 2.0. If a copy of the MPL was not distributed with this
7
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
8
*
9
* This file incorporates work covered by the following license notice:
10
*
11
* Licensed to the Apache Software Foundation (ASF) under one or more
12
* contributor license agreements. See the NOTICE file distributed
13
* with this work for additional information regarding copyright
14
* ownership. The ASF licenses this file to you under the Apache
15
* License, Version 2.0 (the "License"); you may not use this file
16
* except in compliance with the License. You may obtain a copy of
17
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
18
*/
19
20
21
22
module
com
{ module sun { module star { module io {
23
29
published
interface
XInputStream
:
com::sun::star::uno::XInterface
30
{
67
long
readBytes
( [out] sequence<byte> aData,
68
[in]
long
nBytesToRead )
69
raises(
com::sun::star::io::NotConnectedException
,
70
com::sun::star::io::BufferSizeExceededException
,
71
com::sun::star::io::IOException
);
72
89
long
readSomeBytes
( [out] sequence<byte> aData,
90
[in]
long
nMaxBytesToRead )
91
raises(
com::sun::star::io::NotConnectedException
,
92
com::sun::star::io::BufferSizeExceededException
,
93
com::sun::star::io::IOException
);
94
103
void
skipBytes
( [in]
long
nBytesToSkip )
104
raises(
com::sun::star::io::NotConnectedException
,
105
com::sun::star::io::BufferSizeExceededException
,
106
com::sun::star::io::IOException
);
107
113
long
available
()
114
raises(
com
::
sun
::
star
::
io
::
NotConnectedException
,
115
com
::
sun
::
star
::
io
::
IOException
116
);
117
126
void
closeInput
()
127
raises(
com
::
sun
::
star
::
io
::
NotConnectedException
,
128
com
::
sun
::
star
::
io
::
IOException
);
129
130
};
131
132
133
}; }; }; };
134
135
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::io::BufferSizeExceededException
is thrown by instances which need to buffer data.
Definition
BufferSizeExceededException.idl:32
com::sun::star::io::IOException
is thrown when an input or output error has occurred.
Definition
IOException.idl:27
com::sun::star::io::NotConnectedException
is thrown when a read/write operation is tried on an instance that has not been chained properly.
Definition
NotConnectedException.idl:28
com::sun::star::io::XInputStream
This is the basic interface to read data from a stream.
Definition
XInputStream.idl:30
com::sun::star::io::XInputStream::readSomeBytes
long readSomeBytes([out] sequence< byte > aData, [in] long nMaxBytesToRead)
reads the available number of bytes, at maximum nMaxBytesToRead.
com::sun::star::io::XInputStream::readBytes
long readBytes([out] sequence< byte > aData, [in] long nBytesToRead)
reads the specified number of bytes in the given sequence.
com::sun::star::io::XInputStream::available
long available()
states how many bytes can be read or skipped without blocking.
com::sun::star::io::XInputStream::skipBytes
void skipBytes([in] long nBytesToSkip)
skips the next nBytesToSkip bytes (must be positive).
com::sun::star::io::XInputStream::closeInput
void closeInput()
closes the stream.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition
XInterface.idl:46
com::sun::star::io
General input/output interfaces.
Definition
AlreadyConnectedException.idl:22
com::sun::star
the module com::sun::star is the root module of the UNO API.
Definition
Ambiguous.idl:20
com::sun
Definition
Ambiguous.idl:20
com
Definition
Ambiguous.idl:20
com
sun
star
io
XInputStream.idl
Generated by
1.17.0