LibreOffice: com/sun/star/io/XInputStream.idl Source File

LibreOffice LibreOffice 7.3 SDK API Reference

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#ifndef __com_sun_star_io_XInputStream_idl__
20#define __com_sun_star_io_XInputStream_idl__
21
22#include <com/sun/star/uno/XInterface.idl>
23
24#include <com/sun/star/io/NotConnectedException.idl>
25
26#include <com/sun/star/io/BufferSizeExceededException.idl>
27
28
29
30module com { module sun { module star { module io {
31
37published interface XInputStream: com::sun::star::uno::XInterface
38{
75 long readBytes( [out] sequence<byte> aData,
76 [in] long nBytesToRead )
77 raises( com::sun::star::io::NotConnectedException,
78 com::sun::star::io::BufferSizeExceededException,
79 com::sun::star::io::IOException);
80
97 long readSomeBytes( [out] sequence<byte> aData,
98 [in] long nMaxBytesToRead )
99 raises( com::sun::star::io::NotConnectedException,
100 com::sun::star::io::BufferSizeExceededException,
101 com::sun::star::io::IOException );
102
111 void skipBytes( [in] long nBytesToSkip )
112 raises( com::sun::star::io::NotConnectedException,
113 com::sun::star::io::BufferSizeExceededException,
114 com::sun::star::io::IOException );
115
121 long available()
122 raises( com::sun::star::io::NotConnectedException,
123 com::sun::star::io::IOException
124 );
125
134 void closeInput()
135 raises( com::sun::star::io::NotConnectedException,
136 com::sun::star::io::IOException);
137
138};
139
140
141}; }; }; };
142
143#endif
144
145/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
BufferSizeExceededException.idl
NotConnectedException.idl
XInterface.idl
com::sun::star::io::BufferSizeExceededException
is thrown by instances which need to buffer data.
Definition: BufferSizeExceededException.idl:36
com::sun::star::io::IOException
is thrown when an input or output error has occurred.
Definition: IOException.idl:31
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:32
com::sun::star::io::XInputStream
This is the basic interface to read data from a stream.
Definition: XInputStream.idl:38
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::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com
Definition: Ambiguous.idl:22